Create sub-business
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
Role of the business user can be retrieved from GET /users/enumerations/business_roles
Business name
Registration email for the business
Supported country codes for the program can be retrieved from GET /users/enumerations/mobile_country_codes
Supported purpose of account opening for the program can be retrieved from GET /users/enumerations/business_purpose_of_account
Supported id types for the program can be retrieved from GET /users/enumerations/business_id_types
Supported business id issuing country for the program can be retrieved from GET /users/enumerations/business_id_issuance_countries
Business ID issue date (ISO 8601)
Business ID expiry date (ISO 8601)
Client Ref ID
Supported business source of funds for the program can be retrieved from GET /users/enumerations/business_source_of_funds
JSON meta data of additional detail
Response
OK
Response Attributes
Unique identifier for the business
Registration email for the business
Business name details
Show child attributes
Mobile phone details
Show child attributes
Tax identification details
Show child attributes
Business foundation date (ISO 8601)
Type of account
individualbusinessBusiness account status
Show child attributes
Important dates for the business account
Show child attributes
Risk assessment status of the business
PENDINGCLEAREDREJECTEDUNKNOWNClient Ref ID
Source of funds for the business
Purpose of account opening
JSON meta data of additional detail
Role of the business user
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 validation on createinvalid_required_request_parameters— Required request parameters are missing on createcustomer_information_duplicate_error— Duplicate customer information (email/mobile/identification already in use) on createalready_completed_verification— The user has already completed verificationresource_user_id_invalid— The supplied useridis in an invalid format or not found (reactivation)user_already_activated— Cannot activate an already active user (reactivation)resource_user_reactivation_not_allowed— User reactivation is not allowed for the current status (reactivation)
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 invalid (the referenced business_id does not exist or is not a business-type user) [create]user_blocked_risk_threshold_exceeded— The user is risk-flagged/rejected and reactivation is disallowed [reactivation]resource_user_already_terminated— The user is already blocked and the status cannot be updated (reactivation)resource_user_conflict_email_restore— Cannot restore user, an activeemailalready exists (reactivation)resource_user_conflict_mobile_restore— Cannot restore user, an activemobilealready exists (reactivation)
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— General application 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