Update 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
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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
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
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
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
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 (email/mobile change blocked)frequent_information_change_restricted— Information update rejected due to frequent changes within the configured time windowinformation_update_in_progress— A prior information update for the same field is still in progress
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 resourceuser_blocked_risk_threshold_exceeded— The user is risk-flagged and updates are disalloweddisallow_updates— Updates are blocked for the user's current statusdisallow_updates_by_field— One or more of the fields being changed are not allowed for the user's current statususer_status_restricted— User data cannot be modified while an incomplete verification is in progress
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 definitionuser_not_found— No user exists for the supplied userid
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 errordatabase_error— Latest-verification lookup failure during pre-update validationrequest_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
Bad Gateway
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