Send a Verification OTP Code

Telephone number including country code

The two language code as defined in ISO 639-1 along with subtags tag if applicable.

List of types of delivery methods.

Disclosures is the list of disclosures to which a buyer provides consent.

The 'uat' object is optional. It gives UAT instructions to the service, so that users can mimic certain test scenarios. It is primarily used for setting a fixed OTP token instead of using one that is randomly generated. The 'uat' object has no effect on production environments.

The header containing a valid appID.

A response from a successful request to

A identifier referencing an OTP code.

Response for Auth errors

Auth error reason codes

Request_Validation Not_Found Unauthenticated Unauthenticated_Retry_With_PII Unauthenticated_Buyer_Mismatch Unauthenticated_Buyer_Not_Found Invalid_Token Too_Many_Code_Attempts Too_Many_Unverified_Codes_Sent Dependency_Unavailable System_Failure Service_Unavailable

The underlying http status code

A simple message in english describing the error and can be returned to the consumer

The domain where the error is originating from as defined by the service

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Unauthorized. Indicates that provided credentials is not valid

A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain

The underlying http status code

A simple message in english describing the error and can be returned to the consumer

The domain where the error is originating from as defined by the service

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Forbidden. Indicates that request cannot be authorized

A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain

The underlying http status code

A simple message in english describing the error and can be returned to the consumer

The domain where the error is originating from as defined by the service

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Response for Auth errors

Auth error reason codes

The underlying http status code

A simple message in english describing the error and can be returned to the consumer

The domain where the error is originating from as defined by the service

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

200A response from a successful request to POST /api/auth/send-code.

400Response for Auth errors

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

503Response for Auth errors

`POST /api/auth/send-code`.