❖ MatchMove Banking API Specifications

Sections

Theme switcher

Update User

Header Parameters

X-Auth-User-IPstring

The IP using which the actor is making the request

X-Auth-Device-IDstring

The unique id of the device using which the actor is making the request

X-Auth-User-Agentstring

The user agent of the device using which the actor is making the request

X-Auth-Actorstring Required

The actor on behalf of whom the API request is being performed

Path Parameters

program_codestring Required

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.

user_idstring Required

Body Parameters

client_ref_idstring
salutationstring
titlestring
first_namestring
Max length
50
middle_namestring
Max length
50
last_namestring
Max length
50
maiden_namestring
Max length
50
preferred_namestring
Max length
25
genderstring
emailstring
mobile_country_codestring
mobilestring
marital_statusstring
identificationobject
birthobject
nationalitystring
mothers_detailsobject
fathers_detailsobject
addressesobject
employment_typestring
job_titlestring
employment_detailsobject
fatca_crs_confirmed_atstring
fatca_relevantboolean
annual_income_rangestring
main_income_sourcestring
socioprofessional_categorystring
purpose_of_account_openingstring
work_countrystring
residency_countrystring
self_declared_as_pepboolean
tos_acceptanceobject
metadataobject

Response

200
Object

OK

Response Attributes

idstring

Customer generated hash id by MatchMove

client_ref_idstring

A unique reference id for the customer generated by the API consumer

typestring
Enum values:
customercorporate
statusstring

Current user account status

Enum values:
pending_verificationverification_completedactivesuspendedrejectedterminated
sub_statusstring

User account sub-status

salutationstring
titlestring
first_namestring
middle_namestring
last_namestring
maiden_namestring
preferred_namestring
genderstring
emailstring
mobile_country_codestring
mobilestring
marital_statusstring
identificationobject
birthobject
nationalitystring
mothers_detailsobject
fathers_detailsobject
addressesobject
employment_typestring
job_titlestring
employment_detailsobject
fatca_crs_confirmed_atstring
fatca_relevantboolean
annual_income_rangestring
main_income_sourcestring
socioprofessional_categorystring
purpose_of_account_openingstring
work_countrystring
residency_countrystring
self_declared_as_pepboolean
is_email_verifiedstring
Enum values:
01
is_mobile_verifiedstring
Enum values:
01
kyc_statusstring
Enum values:
pendingin_progresscompletednot_submitted
kyc_sub_statusstring
kyc_processed_datestring
risk_assessment_statusstring
Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
transaction_statusstring
transaction_sub_statusstring
tos_acceptanceobject
provider_ref_idstring
provider_account_numberstring
date_createdstring

Account holder created date in YYYY-MM-DDTHH:II:SSZ format

date_updatedstring

Account holder last updated date in YYYY-MM-DDTHH:II:SSZ format

metadataobject
requirementsobject

Fields/actions required at various stages of the user lifecycle

201
Object

Created - The update request has been accepted but not yet fully committed. Partners are required to do additional required action. Refer to immediately_due, eventually_due, pending_verification, and pending_update fields in the response.

Response Attributes

idstring

Customer generated hash id by MatchMove

client_ref_idstring

A unique reference id for the customer generated by the API consumer

typestring
Enum values:
customercorporate
statusstring

Current user account status

Enum values:
pending_verificationverification_completedactivesuspendedrejectedterminated
sub_statusstring

User account sub-status

salutationstring
titlestring
first_namestring
middle_namestring
last_namestring
maiden_namestring
preferred_namestring
genderstring
emailstring
mobile_country_codestring
mobilestring
marital_statusstring
identificationobject
birthobject
nationalitystring
mothers_detailsobject
fathers_detailsobject
addressesobject
employment_typestring
job_titlestring
employment_detailsobject
fatca_crs_confirmed_atstring
fatca_relevantboolean
annual_income_rangestring
main_income_sourcestring
socioprofessional_categorystring
purpose_of_account_openingstring
work_countrystring
residency_countrystring
self_declared_as_pepboolean
is_email_verifiedstring
Enum values:
01
is_mobile_verifiedstring
Enum values:
01
kyc_statusstring
Enum values:
pendingin_progresscompletednot_submitted
kyc_sub_statusstring
kyc_processed_datestring
risk_assessment_statusstring
Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
transaction_statusstring
transaction_sub_statusstring
tos_acceptanceobject
provider_ref_idstring
provider_account_numberstring
date_createdstring

Account holder created date in YYYY-MM-DDTHH:II:SSZ format

date_updatedstring

Account holder last updated date in YYYY-MM-DDTHH:II:SSZ format

metadataobject
requirementsobject

Fields/actions required at various stages of the user lifecycle

202
Object

Accepted - The update request has been accepted but not yet committed. Partners are required to wait for the additional processes to be completed. Subscribe for webhook event USER.INDIVIDUAL.INFORMATION_UPDATE.STATUS to receive updates.

Response Attributes

idstring

Customer generated hash id by MatchMove

client_ref_idstring

A unique reference id for the customer generated by the API consumer

typestring
Enum values:
customercorporate
statusstring

Current user account status

Enum values:
pending_verificationverification_completedactivesuspendedrejectedterminated
sub_statusstring

User account sub-status

salutationstring
titlestring
first_namestring
middle_namestring
last_namestring
maiden_namestring
preferred_namestring
genderstring
emailstring
mobile_country_codestring
mobilestring
marital_statusstring
identificationobject
birthobject
nationalitystring
mothers_detailsobject
fathers_detailsobject
addressesobject
employment_typestring
job_titlestring
employment_detailsobject
fatca_crs_confirmed_atstring
fatca_relevantboolean
annual_income_rangestring
main_income_sourcestring
socioprofessional_categorystring
purpose_of_account_openingstring
work_countrystring
residency_countrystring
self_declared_as_pepboolean
is_email_verifiedstring
Enum values:
01
is_mobile_verifiedstring
Enum values:
01
kyc_statusstring
Enum values:
pendingin_progresscompletednot_submitted
kyc_sub_statusstring
kyc_processed_datestring
risk_assessment_statusstring
Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
transaction_statusstring
transaction_sub_statusstring
tos_acceptanceobject
provider_ref_idstring
provider_account_numberstring
date_createdstring

Account holder created date in YYYY-MM-DDTHH:II:SSZ format

date_updatedstring

Account holder last updated date in YYYY-MM-DDTHH:II:SSZ format

metadataobject
requirementsobject

Fields/actions required at various stages of the user lifecycle

400
Object

Bad Request The response code field indicates which specific rule was violated. Possible error codes:

  • invalid_model — Missing required fields in the request
  • validation_error — One or more request fields failed schema/business validation
  • invalid_required_request_parameters — Required request parameters are missing
  • customer_information_duplicate_error — Duplicate customer information (email/mobile/identification already in use)
  • user_already_exists — A user with the requested email/mobile already exists
  • already_completed_verification — The user has already completed verification (email/mobile change blocked)
  • frequent_information_change_restricted — Information update rejected due to frequent changes within the configured time window
  • information_update_in_progress — A prior information update for the same field is still in progress

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

401
Object

Unauthorized The response code field indicates which specific rule was violated. Possible error codes:

  • access_denied — Access is denied for this resource

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

403
Object

Forbidden The response code field indicates which specific rule was violated. Possible error codes:

  • unauthorized_action — The consumer scope is not allowed to access this resource
  • user_blocked_risk_threshold_exceeded — The user is risk-flagged and updates are disallowed
  • disallow_updates — Updates are blocked for the user's current status
  • disallow_updates_by_field — One or more of the fields being changed are not allowed for the user's current status
  • user_status_restricted — User data cannot be modified while an incomplete verification is in progress

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

404
Object

Not Found The response code field indicates which specific rule was violated. Possible error codes:

  • route_not_defined — The route has no auth definition
  • user_not_found — No user exists for the supplied user id

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

405
Object

Method Not Allowed

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

500
Object

Internal Server Error The response code field indicates which specific rule was violated. Possible error codes:

  • generic_error — General application error
  • database_error — Latest-verification lookup failure during pre-update validation
  • request_fatal_internal — Fatal service error

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

501
Object

Not Implemented

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

502
Object

Bad Gateway

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

503
Object

Service Unavailable

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

504
Object

Gateway Timeout

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?