❖ MatchMove Banking API Specifications

Sections

Theme switcher

Create 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.

Body Parameters

client_ref_idstring

Client's unique reference identifier for the user

Max length
50
Pattern
^[a-zA-Z0-9-\,\.\#\(\)\/ ]+$
preferred_namestring Required

User's preferred name for display purposes

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

User's salutation (Mr., Ms., Dr., etc.)

Pattern
^[A-Za-z?\-#!?'()/@.,:&+\s\d]*$
titlestring

User's professional or personal title. If provided, should be fetched from enum list GET v2/users/enumerations/titles

Max length
5
first_namestring Required

User's first name as per official documents

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

User's full legal name as per official documents

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

User's alias or alternative name

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

Tax Identification Number

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

User's ethnic background

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

User's middle name

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

User's last name or surname

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

User's maiden name (if applicable)

genderstring

User's gender identity. If provided, should be fetched from enum list GET v2/users/enumerations/genders

marital_statusstring

User's marital status. If provided, should be fetched from enum list GET v2/users/enumerations/martial_status

emailstring Required

User's primary email address

Max length
127
Pattern
^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|("..+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
mobile_country_codestring Required

Country code for mobile number. If provided, should be fetched from enum list GET v2/users/enumerations/mobile_country_codes

Max length
3
Pattern
^[0-9]{1,3}$
mobilestring Required

User's mobile phone number without country code

Min length
7
Max length
12
Pattern
^[0-9]*$
supporting_documentsarray

List of supporting identification documents

Max items
10
identificationobject

Primary and secondary identification documents

birthobject
nationalitystring

User's nationality. If provided, should be fetched from enum list GET v2/users/enumerations/nationalities

mothers_detailsobject
fathers_detailsobject
addressesobject

Address structure for individual users

employment_typestring

Type of employment. If provided, should be fetched from enum list GET v2/users/enumerations/employment_type

job_titlestring

User's job title or profession. If provided, should be fetched from enum list GET v2/users/enumerations/job_title

employment_detailsobject
fatca_crs_confirmed_atstring

Timestamp when FATCA/CRS compliance was confirmed

fatca_relevantboolean

Whether user is subject to FATCA reporting

annual_income_rangestring

User's annual income range

main_income_sourcestring

Primary source of income. If provided, should be fetched from enum list GET v2/users/enumerations/main_income_source

socioprofessional_categorystring

Socio-professional category classification

purpose_of_account_openingstring

Stated purpose for opening the account

work_countrystring

Country where user works

residency_statusstring

Status of residency. If provided, should be fetched from enum list GET v2/users/enumerations/residency_status

residency_countrystring

Country of residence. If provided, should be fetched from enum list GET v2/users/enumerations/countries

self_declared_as_pepboolean

Whether user self-declared as Politically Exposed Person

tos_acceptanceobject
provider_ref_idstring

Reference ID from external provider

provider_account_numberstring

Account number assigned by provider

posting_statusstring

Current posting status of the user

data_terms_signed_atstring

Timestamp when data terms were signed

metadataobject

Additional metadata for the user

created_bystring

Email or identifier of who created the user record

Response

200
Object

OK

Response Attributes

idstring

Unique identifier for the user

user_hashstring

Hashed user identifier

typestring

User type

client_ref_idstring

Client's reference ID

provider_ref_idstring

Provider's reference ID

provider_account_numberstring

Account number from provider

salutationstring

User's salutation

titlestring

User's title

first_namestring

User's first name

middle_namestring

User's middle name

last_namestring

User's last name

preferred_namestring

User's preferred name

emailstring

User's email address

mobile_country_codestring

Mobile country code

mobilestring

Mobile number

business_provider_account_numberstring

Business provider account number

genderstring

User's gender

marital_statusstring

User's marital status

identificationobject

Primary and secondary identification documents

birthobject
nationalitystring

User's nationality

mothers_detailsobject
fathers_detailsobject
addressesobject

Address structure for individual users

employment_typestring

Type of employment

job_titlestring

User's job title

employment_detailsobject
fatca_crs_confirmed_atstring

Timestamp when FATCA/CRS was confirmed

fatca_relevantboolean

Whether user is subject to FATCA

data_terms_signed_atstring

Timestamp when data terms were signed

annual_income_rangestring

User's annual income range

main_income_sourcestring

Primary source of income

purpose_of_account_openingstring

Purpose for opening the account

socioprofessional_categorystring

Socio-professional category

work_countrystring

Country where user works

residency_statusstring

Status of residency

residency_countrystring

Country of residence

self_declared_as_pepboolean

Whether user self-declared as Politically Exposed Person

tos_acceptanceobject
metadataobject

Additional metadata

agent_idstring

Agent identifier

partner_idstring

Partner identifier

customer_idstring

Customer identifier

statusstring

Current user status

Enum values:
pending_verificationverification_completedpending_activationactiverejectedsuspendedterminated
sub_statusstring

Current user sub-status

kyc_statusstring

KYC verification status

Enum values:
not_submittedpendingin_progresscompleted
kyc_sub_statusstring

KYC verification sub-status

transaction_statusstring

Transaction status

transaction_sub_statusstring

Transaction sub-status

is_email_verifiedstring

Email verification status

is_mobile_verifiedstring

Mobile verification status

is_risk_flaggedstring

Risk flagging status

Enum values:
UNKNOWNPENDINGCLEAREDREJECTED
kyc_processed_datestring

Date when KYC was processed

date_createdstring

User creation timestamp

date_updatedstring

User last update timestamp

pending_updatearray

List of pending updates

Max items
50
verification_idobject

Verification identifiers

requirementsobject
risk_assesment_statusstring

Risk assessment status

Enum values:
UNKNOWNPENDINGCLEAREDREJECTED
errorsarray

List of errors if any

Max items
20
status_reason_codestring

Reason code for current status

status_messagestring

Status message description

occupationstring

User's occupation

volume_of_assetsstring

Volume of assets

business_idstring

Business identifier

legal_namestring

Legal name

alias_namestring

Alias name

tinstring

Tax Identification Number

ethnicitystring

User's ethnicity

supporting_documentsarray

List of supporting documents

Max items
10
risk_evaluation_datestring

Risk name screening evaluated date

verification_expirystring

User CDD verification expiry date

400
Object

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

  • invalid_payload — Malformed form/JSON request body
  • validation_error — Validation errors
  • customer_information_duplicate_error — Duplication information error, information already in use
  • invalid_model — Invalid model
  • already_completed_verification — The user has already completed verification

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 the authentication failure.

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 why the request was rejected.

Possible error codes:

  • unauthorized_action — The requested action is not permitted for this scope

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 the missing resource.

Possible error codes:

  • route_not_defined — Missing auth definition on the given route

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 the failure category.

Possible error codes:

  • request_fatal_internal — Fatal service error
  • generic_error — General application error
  • database_error — Database 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

Forbidden

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?

POST

/

Select
1

Response

Was this section helpful?