Create business user under 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
Client's unique reference identifier for the business user
Business's preferred name for display purposes
Official registered company name
Date when the company was founded
Legal Entity Identifier (LEI) code for the business
Company website URL
List of alternative or trading names for the business
Show child attributes
Business primary email address
Country code for mobile number (e.g., 65 for Singapore). If provided, should be fetched from enum list GET v2/users/enumerations/mobile_country_codes
Business mobile phone number without country code
List of supporting business identification documents
Show child attributes
Primary and secondary identification documents
Show child attributes
Address structure for business users
Show child attributes
Socio-professional category classification for the business
Stated purpose for opening the business account. If provided, should be fetched from enum list GET v2/users/enumerations/business_purpose_of_account
Primary source of income. If provided, should be fetched from enum list GET v2/users/enumerations/business_source_of_funds
Whether business representatives are Politically Exposed Persons
Show child attributes
Reference ID from external provider
Account number assigned by provider
Current posting status of the business user
Timestamp when data terms were signed
Additional metadata for the business user
Business user role. If provided, should be fetched from enum list GET v2/users/enumerations/business_roles
Type of the company. If provided, should be fetched from enum list GET v2/users/enumerations/business_company_types
Industry type. If provided, should be fetched from enum list GET v2/users/enumerations/industries
Email or identifier of who created the business user record
Response
OK
Response Attributes
Unique identifier for the business user
User type (business)
Client's reference ID for the business user
Provider's reference ID
Account number from provider
Business preferred name
Business email address
Mobile country code
Mobile number
Official company name
Company type
Industry type
Date when company was founded
Role of the user in the business
Alternative or trading names
Show child attributes
Legal Entity Identifier code
Company website URL
Unique Parent business identifier
Primary and secondary identification documents
Show child attributes
Address structure for business users
Show child attributes
Timestamp when data terms were signed
Source of business funds
Purpose for opening the account
Show child attributes
Additional metadata
Current business user status
pending_verificationverification_completedpending_activationactiverejectedsuspendedterminatedCurrent business 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
Business user creation timestamp
Business user last update timestamp
List of pending information updates
Show child attributes
Verification identifiers
Fields requiring provider update
Show child attributes
Show child attributes
Risk assessment status
UNKNOWNPENDINGCLEAREDREJECTEDList of errors if any
Show child attributes
Reason code for current status
Status message description
Volume of business assets
List of supporting business identification 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_payload— Malformed form/JSON request bodyvalidation_error— One or more request fields failed schema/business validation for a business user; the specific field rules are listed insource(e.g.company_name,foundation_date,operationaladdress fields,lei_code,website,company_type,industry,purpose_of_account_opening,supporting_documents,role, etc.)customer_information_duplicate_error— Duplication information error, information already in use (aggregated foremail,mobile,identification.primary.id_type,identification.secondary.id_type)already_completed_verification— The business user has already completed verificationresource_user_inactive— Referenced 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 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
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