Initiate identity verification (v1)

initiateIdentityVerification

Query POST tag:Custom Identity Verification

POST (/internal/v1/identity-verifications)

Parameters

  • X-Request-ID (header): Request ID used for tracing. A new one will be generated if not provided.

Request Body

Responses

201 Created

400 Bad Request

Returned in case of an error, internal server error or invalid request

500 Internal Server Error

Returned in case of an error, internal server error or invalid request

Architecture

2 properties
id string
required

ID to be sent to Bespoke connector. Used to correlate the verification request through api/v1/idantity-verification/{id}

customIdentityAuthRequestDetails object
required

This field will contain al the details required by the IDP (Identity Provider) to initiate an auth session. I.e., personal ID, country, type (MOBILE/SMART), language, localized display message, and others

2 properties
code string
required

Short code to display/compare in the user’s external app.

customIdentityAuthResponseDetails object

Details forwarded from the Bespoke IDP connector to the mobile/web app.

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code