Update users statuses
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
User status action
activatesuspendUser status reason code. Allowed values accessible via /v2/users/enumerations/status_reason_codes
Response
OK
Response Attributes
Unique identifier for the user
Hashed user identifier
User type
Client's reference ID
Provider's reference ID
Account number from provider
User's salutation
User's title
User's first name
User's middle name
User's last name
User's preferred name
User's email address
Mobile country code
Mobile number
Business provider account number
User's gender
User's marital status
Primary and secondary identification documents
Show child attributes
Show child attributes
User's nationality
Show child attributes
Show child attributes
Address structure for individual users
Show child attributes
Type of employment
User's job title
Show child attributes
Timestamp when FATCA/CRS was confirmed
Whether user is subject to FATCA
Timestamp when data terms were signed
User's annual income range
Primary source of income
Purpose for opening the account
Socio-professional category
Country where user works
Status of residency
Country of residence
Whether user self-declared as Politically Exposed Person
Show child attributes
Additional metadata
Agent identifier
Partner identifier
Customer identifier
Current user status
pending_verificationverification_completedpending_activationactiverejectedsuspendedterminatedCurrent user sub-status
KYC verification status
not_submittedpendingin_progresscompletedKYC verification sub-status
Transaction status
Transaction sub-status
Email verification status
Mobile verification status
Risk flagging status
UNKNOWNPENDINGCLEAREDREJECTEDDate when KYC was processed
User creation timestamp
User last update timestamp
List of pending updates
Show child attributes
Verification identifiers
Show child attributes
Risk assessment status
UNKNOWNPENDINGCLEAREDREJECTEDList of errors if any
Show child attributes
Reason code for current status
Status message description
User's occupation
Volume of assets
Business identifier
Legal name
Alias name
Tax Identification Number
User's ethnicity
List of supporting documents
Show child attributes
Risk name screening evaluated date
User CDD verification expiry date
Bad Request
The response code field indicates which specific rule was violated.
Possible error codes:
invalid_model— Missing required fields in the requestuser_improper_id— Useridwas not provided in the requestvalidation_error— Requestedactionvalue is not allowedresource_user_state_invalid— The requested target status is not a permitted state transitionresource_user_inactive— Referenced user is currently inactive/blockeduser_record_already_suspended— User is already suspendedinvalid_action— Requestedactionis not allowed for the current user status
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_status_restricted— User data cannot be modified while CDD 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
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
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