Create user
Header Parameters
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
First name or given name
Last name or family name
User Middle name
Prefereed name
Registration email for the user to be created in the MatchMove system for a particular program.
Supported Country codes for the program can be retrieved from GET /users/enumerations/mobile_country_codes
Minimum 8 Characters , One special character , One number , One small character
Mobile number of the user
Title to be set like mr/miss etc
MrMissDrMrsMadamId type to be set. Available values can be retrieved from GET /users/enumerations/id_types
Id number to be unique
Id type expiry date in standard date format
Issued date of id type in standard date format
Country that issued your id type. Supported values can be retrieved from GET /users/enumerations/countries
alternative id type
Alternative id type number to be unique
Alternative id type expiry date in standard date format
Alternative id type issued date in standard date format
Alternative Id type issuance country
Birthday of the user registered in matchmove system in standard date format
Place where you have born
User Nationality. Supported values can be retrieved from GET /users/enumerations/nationalities
User Gender. Supported values can be retreived from GET /users/enumerations/genders
User marital Status. Supported values can be retreived from GET /users/enumerations/marital_status
Mother's maiden name
Mother's first name. Supported values must be letters and spaces
Mother's last name. Supported values must be letters and spaces
Nature of your business
Customer id to be passed
Purpose of your account
Partner id to be passed
Client Reference ID to be passed
Agent ID to be passed
Employer Name to be passed
User Employment Type. Supported values can be retreived from GET /users/enumerations/employment_type
Source of Funds to be passed
User Occupation. Supported values can be retreived from GET /users/enumerations/occupation
Volume of Assets. Supported values can be retreived from GET /users/enumerations/volume_of_assets
Response
OK
Response Attributes
Customer generated hash id by MatchMove
A unique reference id for the customer generated by the API consumer
customercorporateCurrent user account status
pending_verificationverification_completedactivesuspendedrejectedterminatedUser account sub-status
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
0101pendingin_progresscompletednot_submittedCLEAREDREJECTEDPENDINGUNKNOWN Show child attributes
Account holder created date in YYYY-MM-DDTHH:II:SSZ format
Account holder last updated date in YYYY-MM-DDTHH:II:SSZ format
Fields/actions required at various stages of the user lifecycle
Show child attributes
Bad Request
The response code field indicates which specific rule was violated.
Possible error codes:
invalid_model— Missing required fields in the requestvalidation_error— One or more request fields failed schema/business validationinvalid_required_request_parameters— Required request parameters are missingcustomer_information_duplicate_error— Duplicate customer information (email/mobile/identification already in use)user_already_exists— A user with the requested email/mobile already existsalready_completed_verification— The user has already completed 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
The response code field indicates which specific rule was violated.
Possible error codes:
access_denied— Access is denied for this resource
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
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
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
The response code field indicates which specific rule was violated.
Possible error codes:
route_not_defined— The route has no auth definition
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
Method Not Allowed
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
Internal Server Error
The response code field indicates which specific rule was violated.
Possible error codes:
generic_error— General application errorrequest_fatal_internal— Fatal service error
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 Implemented
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
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