/v1/sessions/{id}/mfa/verify

  • Updated on Apr 21, 2025
  • Published on Jan 30, 2025
Prev Next
Post
/v1/sessions/{id}/mfa/verify

Used to submit the one-time password (OTP) for the Aadhaar Database Verification Check.


Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.



Security
API Key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired
Path parameters
id
stringRequired
Body parameters

Code and OTP type

object
code
string Required

The one-time password (OTP) code

Example123456
type
string Required

Indicates the registry, in this case always "aadhaar"

Exampleaadhaar
Responses
200
object
sessionId
string

Identifier of the verification session the OTP is created for

Exampled91deadc-11ca-4f0a-8dcb-d82aa96f58b7
status
string

Indicates if the OTP generation was successful or not

Valid values[ "\"success\"", "\"fail\"" ]
Examplesuccess
reason
string

Indicates the issue why the request failed. Only sent if it failed

Examplemfa already completed
400

Bad request

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
500

Internal server error

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong



Document Versioning

Article Versioning

Date

Description

Mar 17, 2025

In Response, `status` parameter changed from `boolean` to `string`, valid values: `success`, `fail`

Mar 12, 2025

Documentation published