API explorer
⁍ MatchMove Banking Operating System

Sections

API explorer

Theme switcher

put-users-user id

Header Parameters

Authorizationstring

Path Parameters

user_idstring Required

MatchMove generated id for the user

Body Parameters

client_ref_idstring

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

typestring Required

Customer's type

Enum values:
customercorporate
salutationstring

Customer's saluation

titlestring

Customer's title. Allowed values accesible via /v2/users/enumerations/titles

first_namestring

Customer's first name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
middle_namestring

Customer's middle name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
last_namestring

Customer's last name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
maiden_namestring

Customer's maiden name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
preferred_namestring Required

Customer's preferred name. Do note this is the name which is leveraged at the point of wallet account creation and card creation

Max length
25
Pattern
^[A-Za-z\s]+$
genderstring

Customer's gender. Allowed values accesible via /v2/users/enumerations/genders

emailstring

Customer's email address which will be used for verification

Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
mobile_country_codestring

Country prefix of the verified mobile number to be used by the customer. Allowed values accesible via /v2/users/enumerations/mobile_country_codes

mobilestring

Verified mobile number to be used by the customer

marital_statusstring

Customer's marital_status. Allowed values accesible via /v2/users/enumerations/marital_status

identificationobject

Customer's identification documents details

Show child attributes

birthobject

Customer's birth details

Show child attributes

nationalitystring

Customer's nationality. Allowed values accessible via /v2/users/enumerations/nationalities

mothers_detailsobject

Customer's mother's details

Show child attributes

fathers_detailsobject

Customer's father's details

Show child attributes

addressesobject

Customers addresses

Show child attributes

employment_typestring

Customer's employment type. Allowed values accessible via /v2/users/enumerations/employment_type

job_titlestring

Customer's employment job title

employment_detailsobject

Details of customer's employer

Show child attributes

annual_income_rangestring

Account holder annual income range

main_income_sourcestring

Account holders income source.Below endpoint will get main_income_source enum list v2/users/enumerations/main_income_source

socioprofessional_categorystring

Account holder social professional category

purpose_of_account_openingstring

Account holder purpose of account openings

work_countrystring

Below endpoint will get country enum list v2/users/enumerations/countries

residency_countrystring

Below endpoint will get countries enum list v2/users/enumerations/countries

tos_acceptanceobject

Show child attributes

provider_ref_idstring

Account holder provider reference id

provider_account_numberstring

Account holder provider account number

posting_statusstring

Account holder posting status

data_terms_signed_atstring

data terms signed date

metadataobject

metadata can be used to send additional details which can edited later

created_bystring

Meta data for who created the record

Response

200
Object
OK

Response Attributes

addressesobject

Customers addresses

Show child attributes

agent_idstring

Agent ID

annual_income_rangestring

Account holder annual income range

birthobject

Customer's birth details

Show child attributes

client_ref_idstring

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

customer_idstring

Customer identifier.

created_bystring

Meta data for who created the record

data_terms_signed_atstring

Data Terms signed date

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

emailstring

Customer's email address which will be used for verification

Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
employment_detailsobject

Details of customer's employer

Show child attributes

employment_typestring

Customer's employment type. Allowed values accessible via /v2/users/enumerations/employment_type

errorsarray

List of errors encountered

Show child attributes

fatca_crs_confirmed_atstring

Foreign Tax Compliance and CRS confirmation in YYYY-MM-DDTHH:II:SSZ format

fatca_relevantboolean

Foreign Tax Compliance and CRS relevance

Default value
false
fathers_detailsobject

Customer's father's details

Show child attributes

first_namestring

Customer's first name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
genderstring

Customer's gender. Allowed values accesible via /v2/users/enumerations/genders

idstring

Customer generated hash id by MM

identificationobject

Customer's identification documents details

Show child attributes

is_email_verifiedstring

Account holder email verified status

Enum values:
10
is_mobile_verifiedstring

Account holder mobile verified status

Enum values:
10
is_risk_flaggedstring

Account holder risk status flag

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
job_titlestring

Customer's employment job title

kyc_processed_datestring

KYC processed date in YYYY-MM-DDTHH:II:SSZ format

kyc_statusstring

Account holder current kyc status

Enum values:
pendingin_progresscompleted
kyc_sub_statusstring

Account holder current kyc sub status

Enum values:
pending_document_submissionsubmittedpending_bank_verificationwaiting_for_approvalapproved
last_namestring

Customer's last name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
maiden_namestring

Customer's maiden name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
main_income_sourcestring

Account holders income source.Below endpoint will get main_income_source enum list v2/users/enumerations/main_income_source

marital_statusstring

Customer's marital_status. Allowed values accesible via /v2/users/enumerations/marital_status

metadataobject

metadata can be used to send additional details which can edited later

middle_namestring

Customer's middle name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
mobilestring

Verified mobile number to be used by the customer

mobile_country_codestring

Country prefix of the verified mobile number to be used by the customer. Allowed values accesible via /v2/users/enumerations/mobile_country_codes

mothers_detailsobject

Customer's mother's details

Show child attributes

nationalitystring

Customer's nationality. Allowed values accesible via /v2/users/enumerations/nationalities

partner_idstring

Partner ID

pending_updatearray

List of fields which will get updated to the system only after the respective external dependency (from license provider or any third-party provider) or verification requirements

Nullable:
True

Show child attributes

preferred_namestring

Customer's preferred name. Do note this is the name which is leveraged at the point of wallet account creation and card creation

Max length
25
Pattern
^[A-Za-z\s]+$
provider_account_numberstring

Account holder licensing provider account number

provider_ref_idstring

Account holder licensing provider reference id

purpose_of_account_openingstring

Account holder purpose of account opening

requirementsobject

List of properties and actions which is required to be performed by end-users

Show child attributes

residency_countrystring

Below endpoint will get countries enum list v2/users/enumerations/countries

risk_assessment_statusstring

Account holder risk status

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
salutationstring

Customer's saluation

self_declared_as_pepboolean

Self-Declared Politically Exposed Person

Default value
false
socioprofessional_categorystring

Account holder social professional category

statusstring

Account holder current status

Enum values:
pendingpending_verificationverification_completedpending_activationsuspenedrejectedactiveblacklistedterminated
sub_statusstring

Account holder current sub status

Enum values:
activeuser_createduser_creation_faileddocument_upload_failed_externaldocument_upload_success_externalwaiting_for_approval_by_issueraccount_suspended_by_issueraccount_rejected_by_issueraccount_blocked_by_issueraccount_deleted_by_issuer
... 1 other enums
titlestring

Customer's title. Allowed values accesible via /v2/users/enumerations/titles

tos_acceptanceobject

Show child attributes

transaction_statusstring

Account holder current transaction status

transaction_sub_statusstring

Account holder current transaction sub status

typestring

Customer's type

Enum values:
customercorporate
work_countrystring

Below endpoint will get country enum list v2/users/enumerations/countries

201
Object
Created The update request has been accepted but not yet fully committed. Partners are required to do additional required action. Please refer to below keys on the response on determining the next required action | Field | Description | | -- | -- | | `immediately_due` | Fields/Action which are required to be processed/collected immediately. | | `eventually_due` | Fields that need to be collected but are not crtical for the user process. | | `pending_verification` | Fields that might become required depending on the results of verification or review. It’s an empty object unless an asynchronous verification is pending. | | `pending_update` | Fields which will get updated to the system only after the respective external dependency (from license provider or any third-party provider) or verification requirements. |

Response Attributes

addressesobject

Customers addresses

Show child attributes

agent_idstring

Agent ID

annual_income_rangestring

Account holder annual income range

birthobject

Customer's birth details

Show child attributes

client_ref_idstring

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

customer_idstring

Customer identifier.

created_bystring

Meta data for who created the record

data_terms_signed_atstring

Data Terms signed date

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

emailstring

Customer's email address which will be used for verification

Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
employment_detailsobject

Details of customer's employer

Show child attributes

employment_typestring

Customer's employment type. Allowed values accessible via /v2/users/enumerations/employment_type

errorsarray

List of errors encountered

Show child attributes

fatca_crs_confirmed_atstring

Foreign Tax Compliance and CRS confirmation in YYYY-MM-DDTHH:II:SSZ format

fatca_relevantboolean

Foreign Tax Compliance and CRS relevance

Default value
false
fathers_detailsobject

Customer's father's details

Show child attributes

first_namestring

Customer's first name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
genderstring

Customer's gender. Allowed values accesible via /v2/users/enumerations/genders

idstring

Customer generated hash id by MM

identificationobject

Customer's identification documents details

Show child attributes

is_email_verifiedstring

Account holder email verified status

Enum values:
10
is_mobile_verifiedstring

Account holder mobile verified status

Enum values:
10
is_risk_flaggedstring

Account holder risk status flag

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
job_titlestring

Customer's employment job title

kyc_processed_datestring

KYC processed date in YYYY-MM-DDTHH:II:SSZ format

kyc_statusstring

Account holder current kyc status

Enum values:
pendingin_progresscompleted
kyc_sub_statusstring

Account holder current kyc sub status

Enum values:
pending_document_submissionsubmittedpending_bank_verificationwaiting_for_approvalapproved
last_namestring

Customer's last name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
maiden_namestring

Customer's maiden name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
main_income_sourcestring

Account holders income source.Below endpoint will get main_income_source enum list v2/users/enumerations/main_income_source

marital_statusstring

Customer's marital_status. Allowed values accesible via /v2/users/enumerations/marital_status

metadataobject

metadata can be used to send additional details which can edited later

middle_namestring

Customer's middle name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
mobilestring

Verified mobile number to be used by the customer

mobile_country_codestring

Country prefix of the verified mobile number to be used by the customer. Allowed values accesible via /v2/users/enumerations/mobile_country_codes

mothers_detailsobject

Customer's mother's details

Show child attributes

nationalitystring

Customer's nationality. Allowed values accesible via /v2/users/enumerations/nationalities

partner_idstring

Partner ID

pending_updatearray

List of fields which will get updated to the system only after the respective external dependency (from license provider or any third-party provider) or verification requirements

Nullable:
True

Show child attributes

preferred_namestring

Customer's preferred name. Do note this is the name which is leveraged at the point of wallet account creation and card creation

Max length
25
Pattern
^[A-Za-z\s]+$
provider_account_numberstring

Account holder licensing provider account number

provider_ref_idstring

Account holder licensing provider reference id

purpose_of_account_openingstring

Account holder purpose of account opening

requirementsobject

List of properties and actions which is required to be performed by end-users

Show child attributes

residency_countrystring

Below endpoint will get countries enum list v2/users/enumerations/countries

risk_assessment_statusstring

Account holder risk status

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
salutationstring

Customer's saluation

self_declared_as_pepboolean

Self-Declared Politically Exposed Person

Default value
false
socioprofessional_categorystring

Account holder social professional category

statusstring

Account holder current status

Enum values:
pendingpending_verificationverification_completedpending_activationsuspenedrejectedactiveblacklistedterminated
sub_statusstring

Account holder current sub status

Enum values:
activeuser_createduser_creation_faileddocument_upload_failed_externaldocument_upload_success_externalwaiting_for_approval_by_issueraccount_suspended_by_issueraccount_rejected_by_issueraccount_blocked_by_issueraccount_deleted_by_issuer
... 1 other enums
titlestring

Customer's title. Allowed values accesible via /v2/users/enumerations/titles

tos_acceptanceobject

Show child attributes

transaction_statusstring

Account holder current transaction status

transaction_sub_statusstring

Account holder current transaction sub status

typestring

Customer's type

Enum values:
customercorporate
work_countrystring

Below endpoint will get country enum list v2/users/enumerations/countries

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. Please refer to below keys on the response on determining what is happening on the process | Field | Description | | -- | -- | | `immediately_due` | Fields/Action which are required to be processed/collected immediately. | | `eventually_due` | Fields that need to be collected but are not crtical for the user process. | | `pending_verification` | Fields that might become required depending on the results of verification or review. It’s an empty object unless an asynchronous verification is pending. | | `pending_update` | Fields which will get updated to the system only after the respective external dependency (from license provider or any third-party provider) or verification requirements. | Partners will need to subscribe for below webhook event in order to receive updates : `USER.INDIVIDUAL.INFORMATION_UPDATE.STATUS`

Response Attributes

addressesobject

Customers addresses

Show child attributes

agent_idstring

Agent ID

annual_income_rangestring

Account holder annual income range

birthobject

Customer's birth details

Show child attributes

client_ref_idstring

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

customer_idstring

Customer identifier.

created_bystring

Meta data for who created the record

data_terms_signed_atstring

Data Terms signed date

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

emailstring

Customer's email address which will be used for verification

Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
employment_detailsobject

Details of customer's employer

Show child attributes

employment_typestring

Customer's employment type. Allowed values accessible via /v2/users/enumerations/employment_type

errorsarray

List of errors encountered

Show child attributes

fatca_crs_confirmed_atstring

Foreign Tax Compliance and CRS confirmation in YYYY-MM-DDTHH:II:SSZ format

fatca_relevantboolean

Foreign Tax Compliance and CRS relevance

Default value
false
fathers_detailsobject

Customer's father's details

Show child attributes

first_namestring

Customer's first name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
genderstring

Customer's gender. Allowed values accesible via /v2/users/enumerations/genders

idstring

Customer generated hash id by MM

identificationobject

Customer's identification documents details

Show child attributes

is_email_verifiedstring

Account holder email verified status

Enum values:
10
is_mobile_verifiedstring

Account holder mobile verified status

Enum values:
10
is_risk_flaggedstring

Account holder risk status flag

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
job_titlestring

Customer's employment job title

kyc_processed_datestring

KYC processed date in YYYY-MM-DDTHH:II:SSZ format

kyc_statusstring

Account holder current kyc status

Enum values:
pendingin_progresscompleted
kyc_sub_statusstring

Account holder current kyc sub status

Enum values:
pending_document_submissionsubmittedpending_bank_verificationwaiting_for_approvalapproved
last_namestring

Customer's last name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
maiden_namestring

Customer's maiden name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
main_income_sourcestring

Account holders income source.Below endpoint will get main_income_source enum list v2/users/enumerations/main_income_source

marital_statusstring

Customer's marital_status. Allowed values accesible via /v2/users/enumerations/marital_status

metadataobject

metadata can be used to send additional details which can edited later

middle_namestring

Customer's middle name

Max length
50
Pattern
^[#.0-9a-zA-Z\s,\/\-_:+?'\(\)@#!&]+$
mobilestring

Verified mobile number to be used by the customer

mobile_country_codestring

Country prefix of the verified mobile number to be used by the customer. Allowed values accesible via /v2/users/enumerations/mobile_country_codes

mothers_detailsobject

Customer's mother's details

Show child attributes

nationalitystring

Customer's nationality. Allowed values accesible via /v2/users/enumerations/nationalities

partner_idstring

Partner ID

pending_updatearray

List of fields which will get updated to the system only after the respective external dependency (from license provider or any third-party provider) or verification requirements

Nullable:
True

Show child attributes

preferred_namestring

Customer's preferred name. Do note this is the name which is leveraged at the point of wallet account creation and card creation

Max length
25
Pattern
^[A-Za-z\s]+$
provider_account_numberstring

Account holder licensing provider account number

provider_ref_idstring

Account holder licensing provider reference id

purpose_of_account_openingstring

Account holder purpose of account opening

requirementsobject

List of properties and actions which is required to be performed by end-users

Show child attributes

residency_countrystring

Below endpoint will get countries enum list v2/users/enumerations/countries

risk_assessment_statusstring

Account holder risk status

Enum values:
CLEAREDREJECTEDPENDINGUNKNOWN
salutationstring

Customer's saluation

self_declared_as_pepboolean

Self-Declared Politically Exposed Person

Default value
false
socioprofessional_categorystring

Account holder social professional category

statusstring

Account holder current status

Enum values:
pendingpending_verificationverification_completedpending_activationsuspenedrejectedactiveblacklistedterminated
sub_statusstring

Account holder current sub status

Enum values:
activeuser_createduser_creation_faileddocument_upload_failed_externaldocument_upload_success_externalwaiting_for_approval_by_issueraccount_suspended_by_issueraccount_rejected_by_issueraccount_blocked_by_issueraccount_deleted_by_issuer
... 1 other enums
titlestring

Customer's title. Allowed values accesible via /v2/users/enumerations/titles

tos_acceptanceobject

Show child attributes

transaction_statusstring

Account holder current transaction status

transaction_sub_statusstring

Account holder current transaction sub status

typestring

Customer's type

Enum values:
customercorporate
work_countrystring

Below endpoint will get country enum list v2/users/enumerations/countries

400
Object
Bad Request | Code | Description | | :---------- | :---------- | | invalid_model | Validation errors | | already_completed_verification | The user has already completed verification | | frequent_information_change_restricted | Frequent update of information is restricted | | information_update_in_progress | The information update is still being processed | | customer_information_duplicate_error | Duplication information error, information already in use |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

403
Object
Forbidden | Code | Description | | :---------- | :---------- | | user_blocked_risk_threshold_exceeded | User have exceeded the risk and compliance threshold and was automatically blocked. | | disallow_updates | Update feature is blocked (based on user status or field) |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

404
Object
Bad Request | Code | Description | | :---------- | :---------- | | user_not_found | User not found. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

500
Object
Internal Server Error | Code | Description | | :---------- | :---------- | | generic_error | General Error | | internal_server_error | Internal Error / DB Transaction commit error |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

502
Object
Bad Gateway

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

503
Object
Service Unavailable

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

504
Object
Gateway Timeout

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourceoneof

Show child attributes

timestampstring Required

Response timestamp

Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude