⁍ MatchMove Banking Operating System

Sections

Theme switcher

Update KYC status

Header Parameters

X-Auth-User-IDstring Required

MatchMove provided ID for the user.

Authorizationstring

Body Parameters

statusstring Required

Approved or rejected status

Enum values:
approvedrejected
sub_statusstring

The sub status information of the approval or rejection process.

Allowed values must be fetched from /users/enumerations/document_substatuses.

Do note that each sub_status in the enumerations API is separated by status under approved OR rejected

messagestring

Additional KYC Message

kyc_detailsstring

JSON encoded text string containing the KYC details

kyc_typestring

KYC Type

Allowed values must be fetched from /users/enumerations/kyc_types.

Response

200
Object
OK

Response Attributes

successstring

Status of the request

verification_idstring

Generated hash id for the document verification process

countinteger Required

Count of documents submitted. If not documents submitted. It will show n/a

statusstring Required

Status of the Identity authentication process

Status Scenario
pending after Create KYC or Create KYB
submitted after Confirm KYC Submission or Confirm KYB Submission
approved after Update KYC or KYB Status
rejected after Update KYC or KYB Status
Enum values:
not_submittedpendingsubmittedapprovedrejected
sub_statusstring

The description that is fetched from below enumeations based on the sub_status_code.

Account Type Enumeration
individual /users/enumerations/document_substatuses
business /users/enumerations/business_document_substatuses

For POST users/authentications/documents or `POST businesses/authentications/documents method:

Sub Status Description
PENDING_DOCUMENT_SUBMISSION The documents are pending for submissio...
sub_status_codestring

The code that is fetched from below enumerations

Account Type Enumeration
individual /users/enumerations/document_substatuses
business /users/enumerations/business_document_substatuses

For POST users/authentications/documents method:

Sub Status Description
PENDING_DOCUMENT_SUBMISSION The documents are pending for submission

For PUT users/authentications/documents method: | Sub Status | Description | ...

documentsarray

Array that represents a list of documents submitted during the most recent KYC verification process. Please note that if the status is not_submitted, no document list will be provided.

Show child attributes

kyc_detailsobject

Additional metadata for the KYC authentication process

Note : If either kyc_type or message is present in the PUT users/authentications/statuses request payload, these will appear inside the kyc_details object as part of response.

Nullable:
True
kyc_typestring
messagestring
400
Object
Bad Request | Code | Description | | :--- | :---------- | | hash_id_not_empty | Parameter user `hash_id` must not be empty. | | resource_user_kyc_record_not_found | User kyc record not found. | | resource_user_unrecognized_kyc_type | Invalid parameter `kyc_type`. | | resource_user_authentication_document_kyc_details_invalid | Parameter `kyc_details` is invalid. | | resource_user_authentication_document_sub_status_not_allowed | Parameter `sub_status` is invalid. | | resource_user_id_invalid | User `id` is either in an invalid format or not found. |

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
401
Object
Unauthorized request

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
403
Object
Forbidden | Code | Description | | :--- | :---------- | | resource_user_authentication_document_not_allowed_invalid | `status` is invalid. | | resource_user_authentication_document_not_allowed | Current status has prevented this request to resolve. |

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
404
Object
Resource not found

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
500
Object
Internal Server Error

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
502
Object
Bad Gateway

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
503
Object
External Service Error

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
504
Object
Gateway timeout

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?