Initiate KYC process
Header Parameters
The matchmove issued user_id for which the request is being made
The IP using which the actor is making the request
The unique id of the device using which the actor is making the request
The user agent of the device using which the actor is making the request
The actor on behalf of whom the API request is being performed
Path Parameters
Unique identifier for your program, issued by MatchMove during onboarding. All requests must use the program_code assigned to your integration. Using a program_code that does not belong to your integration will result in an authorization error.
Body Parameters
Specifies the verification flow to be initiated.
document_basedauthentication_basedResponse
OK
Response Attributes
Indicates whether the verification session was successfully created.
Unique identifier of the user for whom the verification was initiated.
Unique identifier of the verification session. This identifier should be used for all subsequent verification-related operations.
verification session creation date.
Verification flow selected for the current verification session. The returned requirements depend on the selected verification mode.
document_basedauthentication_basedDefines the documents, attributes, and actions required to complete the verification flow. Clients should always process the returned requirements instead of assuming the next verification step.
Show child attributes
Bad Request
Code | Description |
invalidverificationmode | invalid |
invalid_model | Validation errors |
alreadycompletedverification | The profile has already completed the kyc verification |
stillinprogress_verification | The profile has an ongoing check for kyc verification |
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Unauthorized
Code | Description |
invalid_tenant | Access denied due to invalid program_code on header |
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Forbidden
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Not Found
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Unprocessable Entity
Code | Description |
verificationprerequisitesmissing | verification cannot be initiated. Please complete the required attributes and actions listed in the requirements |
verificationstatusrestricted | verification data cannot be modified once CDD verification has started |
Response Attributes
Unique error identifier
HTTP status code
Error code identifier
Error title
Detailed error description
Defines the documents, attributes, and actions required to complete the verification flow when the request cannot be completed yet.
Show child attributes
Error timestamp
Internal Server Error
Code | Description |
requestfatalinternal | Fatal service error |
internalservererror | Something went wrong when processing your request |
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Bad Gateway
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Service Unavailable
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Gateway Timeout
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API