Skip to content

Email Verification API

New

Send a one-time code to the email address a person gives you and confirm the code they enter, so you know they can read mail at that address.

Overview

An email address typed into a form proves nothing on its own. It may have a typo in it, or it may belong to someone else. Businesses that send statements, alerts, password resets or agreements by email need to know the person can actually read mail at the address they gave. The usual way to prove it is a one-time code. The Email Verification API is two calls. The first sends a one-time code to the address. The second confirms the code the person enters and tells you whether the address is verified.

Category
KYC Services
Coverage
Any email address the person can receive mail at
Input
Email address and the person's name, then the one-time code they enter
Output
A verification reference and confirmation the code was sent, then whether the address is verified
Typical users
Lenders, fintech and payment platforms, insurers, marketplaces, any business with email-led accounts
Coverage note
Works for any address that can receive mail

The overview and the sections after the reference are the FinSour API catalog’s own record for this service, rendered unaltered.

Endpoint URL and method

POSThttps://gateway.staging.finsour.io/v1/identity/email-start

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Authentication

Scheme API key travels in the X-Api-Key header

Send your API key in this header on every call, from your own server: a key sent from a browser is refused. A key starting fs_test_ calls the sandbox and one starting fs_live_ calls production, at the same address. Create keys in the FinSour console.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Request parameters

Content type application/json

Headers

NameTypeRequiredDescriptionConstraints
Idempotency-KeystringRequiredA key you generate for each attempt. Sending the same key again returns the first answer instead of running the check twice; the same key with a different body is refused.8 to 255 characters. Matches ^[A-Za-z0-9._:-]+$

Body

NameTypeRequiredDescriptionConstraints
inputobjectRequiredThe details to check.—
input.emailstringRequired—Matches ^[^\s@]+@[^\s@]+\.[^\s@]+$. 6 to 254 characters
input.namestringRequired—Matches ^[A-Za-z ]+$. 1 to 120 characters
optionsobjectRequiredSettings for this call. This API requires consent.—
options.referencestringOptionalYour own reference for this call. It comes back unchanged as meta.reference.1 to 128 characters
options.consentobjectRequiredThe person's consent to this check.—
options.consent.obtainedbooleanRequiredSend true once the person has agreed to the check.Always true
options.consent.atstring (date-time)RequiredWhen the person gave consent.—
options.consent.purposestringRequiredWhat the check is for, for example kyc.1 to 64 characters

Request samples

cURL

curl -X POST https://gateway.staging.finsour.io/v1/identity/email-start \
  -H "X-Api-Key: $FINSOUR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "email": "<email>",
    "name": "<name>"
  },
  "options": {
    "consent": {
      "obtained": "<obtained>",
      "at": "<at>",
      "purpose": "<purpose>"
    }
  }
}'

Node.js

const response = await fetch("https://gateway.staging.finsour.io/v1/identity/email-start", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.FINSOUR_API_KEY,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "input": {
      "email": "<email>",
      "name": "<name>"
    },
    "options": {
      "consent": {
        "obtained": "<obtained>",
        "at": "<at>",
        "purpose": "<purpose>"
      }
    }
  }),
});

console.log(response.status, await response.json());

Python

import os
import uuid

import requests

response = requests.post(
    "https://gateway.staging.finsour.io/v1/identity/email-start",
    headers={
        "X-Api-Key": os.environ["FINSOUR_API_KEY"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "input": {
            "email": "<email>",
            "name": "<name>",
        },
        "options": {
            "consent": {
                "obtained": "<obtained>",
                "at": "<at>",
                "purpose": "<purpose>",
            },
        },
    },
    timeout=30,
)

print(response.status_code, response.json())

Generated from the fields above. Replace each value in angle brackets with your own; the key is read from FINSOUR_API_KEY.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Response schema

Status 200 · content type application/json

NameTypePresentDescriptionConstraints
dataobjectAlwaysThe result of the check.—
data.verificationIdstringAlwaysSend this, with the code the person received, to identity/email-verify-otp.Matches ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
data.codeSentbooleanAlwaysWhether a code was sent to the address.—

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Error codes

CodeStatusMeaningRetrying
API_VERSION_UNSUPPORTED400That API version is no longer supported.Do not retry automatically
IDEMPOTENCY_KEY_INVALID400That Idempotency-Key does not meet the required format.Do not retry automatically
IDEMPOTENCY_KEY_REQUIRED400An Idempotency-Key header is required for this request.Do not retry automatically
REQUEST_MALFORMED400The request could not be parsed.Do not retry automatically
AUTH_KEY_EXPIRED401The API key is not valid.Do not retry automatically
AUTH_KEY_INVALID401The API key is not valid.Do not retry automatically
AUTH_KEY_MISSING401No API key was presented.Do not retry automatically
AUTH_KEY_REVOKED401The API key is not valid.Do not retry automatically
INSUFFICIENT_BALANCE402The available balance is not enough for this request.Do not retry automatically
AUTH_IP_NOT_ALLOWED403This API key may not be used from this address.Do not retry automatically
ENTITLEMENT_MISSING403This organization is not entitled to that product in this environment.Do not retry automatically
ORGANIZATION_SUSPENDED403This organization is not active.Do not retry automatically
PRODUCT_NOT_AVAILABLE403That product is not available.Do not retry automatically
PRODUCT_RETIRED403That product has been withdrawn.Do not retry automatically
SCOPE_INSUFFICIENT403This API key does not carry the scope this product requires.Do not retry automatically
PRODUCT_NOT_FOUND404No such product.Do not retry automatically
IDEMPOTENCY_KEY_REUSED409That idempotency key was already used for a different request.Do not retry automatically
PRICE_UNAVAILABLE409No active price covers this product right now.Safe to retry
REQUEST_IN_PROGRESS409An earlier attempt with this key is still running.Safe to retry
SETTLEMENT_PENDING409This request is awaiting reconciliation by an operator.Do not retry automatically
API_VERSION_SUNSET410That API version passed its announced sunset date.Do not retry automatically
REQUEST_TOO_LARGE413The request body is too large.Do not retry automatically
UNSUPPORTED_MEDIA_TYPE415That content type is not accepted on this route.Do not retry automatically
CONSENT_REQUIRED422This product requires an explicit consent flag.Do not retry automatically
SANDBOX_FIXTURE_MISSING422No sandbox fixture exists for this input. Use a different test value.Do not retry automatically
UPSTREAM_REJECTED422The upstream source rejected the input.Do not retry automatically
VALIDATION_FAILED422The request payload is invalid.Do not retry automatically
CONCURRENCY_LIMIT429Too many simultaneous requests.Safe to retry
QUOTA_EXCEEDED429The allowance for this window is spent.Do not retry automatically
RATE_LIMITED429Too many requests.Safe to retry
INTERNAL_ERROR500An unexpected error occurred.Safe to retry
OUTCOME_UNCERTAIN502The outcome of this request is not yet known. Retry with the same Idempotency-Key.Do not retry automatically
UPSTREAM_UNAVAILABLE502The upstream source is unavailable. Retry shortly.Safe to retry
MAINTENANCE_MODE503The service is in a maintenance window.Safe to retry
NO_PROVIDER_AVAILABLE503No provider can serve this product right now.Safe to retry
SERVICE_OVERLOADED503The service is shedding load. Retry shortly.Safe to retry
UPSTREAM_TIMEOUT504The upstream source did not respond in time.Safe to retry

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Rate limits

ScopeLimitWindowAt the limit
Your API key, within your organisation's limitThe figure in X-RateLimit-LimitPer minute429 RATE_LIMITED, with Retry-After in seconds. Every answer past authentication carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.

Use cases

  • Sign-up: confirming the address before an account is opened
  • Lending: verifying where statements and agreements will be sent
  • Payments: checking the address used for alerts and password resets
  • Account changes: verifying a new address before it replaces the old one

What this service does

  • Two calls: send and confirm

    The first call sends a one-time code to the address and returns a verification reference. The second confirms the code the person enters.

  • A clear verified answer

    The confirm call says whether the address is verified, so your flow moves on only when it is.

  • Runs inside your own flow

    The person enters the code in your application. They are not sent to another site.

  • Retries are part of the flow

    A wrong or expired code is an answer your flow handles, by letting the person try again or sending a new code.

How a check runs

  1. Arrange access

    Tell us where email verification fits in your sign-up or account flow. We arrange access for your organization under the applicable service contract.

  2. Send the code

    Your application sends the email address and the person's name, and keeps the verification reference from the response.

  3. The person enters the code

    The person reads the code in their mailbox and types it into your application.

  4. Confirm the code

    Your application sends the code with the verification reference and reads whether the address is verified.

  5. Record the verified address

    Store the verified address and the time it was verified with the account.

Questions

How does the Email Verification API work?
It is two calls. The first sends a one-time code to the email address and returns a verification reference. The second sends the code the person entered, with that reference, and returns whether the address is verified.
What do I send to start?
The email address and the person's name. The response gives you the verification reference you send back with the code.
What if the person enters the wrong code?
The confirm call answers that the code was not accepted. Let the person try again, or send a new code with the first call.
Do I need the person's consent?
Sending a code names a person to the service, so run it with their consent for a stated purpose, usually the account they are opening, and tell them a code is on its way.
Does verifying an address prove who the person is?
No. It proves the person can read mail at that address. Pair it with an identity check, such as PAN or DigiLocker, when you need to know who they are.
How do I get access to the Email Verification API?
Start with Get API and tell us how email verification fits your flow and what volumes you expect. We set up access under the applicable service contract.

Catalog entry last updated .