Update business
Header Parameters
The matchmove issued user_id for which the request is being made
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
The name of the business.
Registration email for the business
Supported Country codes for the business can be retrieved from GET /users/enumerations/mobile_country_codes
Mobile number of the business
The date when the business was founded in standard date format
The business purpose for opening the account
Number of the tax identification document
Country where the tax document was issued
Issued date of id type in standard date format
Id type expiry date in standard date format
Client Reference ID to be passed
Source of Funds to be passed
JSON meta data of additional detail
Response
OK
Response Attributes
Registration email for the business.
Show child attributes
Show child attributes
Show child attributes
Date when the business was founded.
Type of account. Business or individual
individualbusiness Show child attributes
Show child attributes
Risk Evaluation of the Business
PENDINGIN_PROCESSCLEAREDREJECTEDSource of funds for business
The business purpose for opening the account.
JSON meta data of additional detail
Role of the business users
Bad Request
The response code field indicates which specific rule was violated.
Possible error codes:
invalid_payload— Malformed form/JSON request bodyinvalid_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)already_completed_verification— The user has already completed verification (email/mobile change blocked)update_user_fields_disabled_post_kyc— Updating the referenced fields is disabled after KYC approvalresource_user_inactive— The business user is currently inactive/blocked
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 the authentication failure.
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 resourcerestricted_resource— This V1 route is blocked for the current program_coderesource_user_business_id_rule— Parameterbusiness_idis invalidresource_user_no_access— The referenced user is not of the business type for this routedisallow_updates— Updates are blocked for the user's current KYC/provider 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 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
The response code field indicates the missing resource.
Possible error codes:
route_not_defined— Missing auth definition on the given route
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 the failure category.
Possible error codes:
request_fatal_internal— Fatal service errorinternal_server_error— Unclassified error returned by the upstream KYC service
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