---
updatedAt: 2026-09-02T06:01:36.000Z
---
# Add Onboarding Data (New)
Submit onboarding data for a company or sub-account, track review and RFI states, and wait for approval before enabling operational activity.
> Onboarding data is required for both Atlas for Fintech & Atlas for Platform use cases. This includes - UBO Information for any UBO that owns 25%+ of a company.
**Check your base URL**
Each Verto service has its own host. Use the base URL shown in the endpoint definition on this page — do not reuse a host from another service.
Sandbox hosts end in `-sandbox.vertofx.com`; the matching production host replaces `sandbox` with `beta`. Sending a request to the wrong environment returns `403`.
See [URLs (Sandbox vs Production)](/docs/urls-sandbox-vs-production) for the full service-by-service list.
For a full guide on required information for each sub account, please refer to this reference guide: Atlas for Platform Required Information.
Ensure that for Atlas for Platforms both at least one shareholder with +25% and at least one director is added, a client can not be onboarded without provision of each of these.
A director is marked using the isControllingOfficer=true field. A director must have an email address for Atlas for Platform use cases, in order to recieve email to accept Terms and Conditions as final onboarding step.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Onboarding (New)",
"description": "The only cross-border payments API with payment coverage across developed and emerging markets. Get the tools, resources, and guides you need to build a great cross-border payment experience for your business. Let's help you reach your growth goals.\n",
"version": "1.0.0",
"license": {
"name": "",
"url": " "
}
},
"servers": [
{
"url": "https://api-onboarding-sandbox.vertofx.com",
"description": "For onboarding (New) APIs"
}
],
"x-readme": {
"samples-languages": [
"shell",
"node",
"ruby",
"javascript",
"python",
"csharp",
"php"
]
},
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/companies/{companyId}/onboarding-data": {
"post": {
"summary": "Add Onboarding Data (New)",
"operationId": "add_onboarding_data_new",
"description": "Submit onboarding data for a company or sub-account, track review and RFI states, and wait for approval before enabling operational activity.",
"tags": [
"Onboarding"
],
"parameters": [
{
"$ref": "#/components/parameters/companyId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientOnboardingRq"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated onboarding data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientOnboardingRs"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest-400"
},
"401": {
"$ref": "#/components/responses/Unauthorized-401"
},
"403": {
"$ref": "#/components/responses/Forbidden-403"
},
"404": {
"$ref": "#/components/responses/NotFound-404"
},
"500": {
"$ref": "#/components/responses/InternalServerError-500"
}
}
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Example:\n> Authorization: Bearer token\n"
}
},
"parameters": {
"companyId": {
"name": "companyId",
"in": "path",
"description": "The unique identifier for the company.",
"required": true,
"schema": {
"type": "string"
}
}
},
"responses": {
"BadRequest-400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Displays HTTP error code.\n"
},
"message": {
"type": "string",
"description": "Displays error message."
}
}
}
}
}
},
"NotFound-404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Displays HTTP error code.\n"
},
"message": {
"type": "string",
"description": "Displays error message."
}
}
}
}
}
},
"Unauthorized-401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "The request lacks valid authentication credentials. Please ensure you have the necessary authorization tokens and try again.",
"properties": {
"code": {
"type": "number",
"description": "Displays HTTP error code.\n"
},
"message": {
"type": "string",
"description": "Displays error message."
}
}
}
}
}
},
"Forbidden-403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Displays HTTP error code.\n"
},
"message": {
"type": "string",
"description": "Displays error message."
}
}
}
}
}
},
"InternalServerError-500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Displays HTTP error code.\n"
},
"message": {
"type": "string",
"description": "Displays error message."
}
}
}
}
}
}
},
"schemas": {
"ClientOnboardingRq": {
"type": "object",
"properties": {
"selectedProducts": {
"$ref": "#/components/schemas/Products"
},
"company": {
"$ref": "#/components/schemas/ClientCompanyRq"
},
"companyAddresses": {
"type": "array",
"maxItems": 2,
"items": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"$ref": "#/components/schemas/PostAction"
},
"data": {
"$ref": "#/components/schemas/ClientCompanyAddress"
}
}
}
},
"shareholders": {
"type": "array",
"maxItems": 5,
"items": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"$ref": "#/components/schemas/PostAction"
},
"data": {
"$ref": "#/components/schemas/ClientShareholder"
}
}
}
},
"companyDocuments": {
"type": "array",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/ApiClientCompanyDocumentPostRq"
}
},
"shareholderDocuments": {
"type": "array",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/ApiClientShareholderDocumentPostRq"
}
},
"riskAssessment": {
"$ref": "#/components/schemas/RiskAssessment"
}
}
},
"ClientOnboardingRs": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditableBaseObj"
},
{
"type": "object",
"properties": {
"companyId": {
"type": "string",
"description": "Company ID",
"example": "2"
},
"parentCompanyId": {
"type": "string",
"description": "Parent Company ID",
"example": "1"
},
"signUpVerification": {
"$ref": "#/components/schemas/SignUpVerification"
},
"selectedProducts": {
"$ref": "#/components/schemas/Products"
},
"company": {
"$ref": "#/components/schemas/ClientCompanyRs"
},
"shareholders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientShareholder"
}
},
"progress": {
"$ref": "#/components/schemas/OnboardingProgressArray"
},
"status": {
"$ref": "#/components/schemas/OnboardingStatus"
},
"companyDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiClientCompanyDocumentPostRq"
}
},
"riskAssessment": {
"$ref": "#/components/schemas/RiskAssessment"
},
"kycLevel": {
"readOnly": true,
"type": "string",
"enum": [
"0",
"3"
]
}
}
}
]
},
"ClientCompanyRq": {
"type": "object",
"description": "The detailed information of the company.",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/EntityType"
},
{
"description": "The legal entity type of the company."
}
]
}
}
},
"ClientCompanyRs": {
"allOf": [
{
"$ref": "#/components/schemas/ClientCompanyRq"
},
{
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientCompanyAddress"
}
}
}
}
]
},
"OnboardingProgressArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnboardingProgress"
}
},
"OnboardingProgress": {
"type": "object",
"required": [
"state",
"percentageCompleted"
],
"properties": {
"state": {
"$ref": "#/components/schemas/OnboardingState"
},
"percentageCompleted": {
"description": "Percentage completed",
"type": "integer",
"example": 50
},
"lastUpdatedAt": {
"description": "Last visited date time",
"type": "string",
"format": "date-time",
"example": "2022-05-14T02:35:53.455+05:30"
}
}
},
"SignUpVerification": {
"type": "object",
"properties": {
"isMobileVerified": {
"description": "Whether the user's mobile is verified or not",
"type": "boolean",
"example": false
},
"mobileVerifiedAt": {
"description": "The date and time when the user's mobile number was verified",
"type": "string",
"format": "date-time",
"nullable": true,
"example": null
},
"isEmailVerified": {
"description": "Whether the user's email is verified or not",
"type": "boolean",
"example": true
},
"emailVerifiedAt": {
"description": "The date and time when the user's email was verified",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2022-05-14T02:35:53.455+05:30"
}
}
},
"Products": {
"type": "array",
"description": "The array of products that the company has selected.",
"items": {
"type": "string",
"enum": [
"Collect",
"Convert",
"Pay",
"Hold",
"API"
]
},
"minItems": 1,
"example": [
"Collect",
"Convert",
"Pay"
]
},
"AddressBase": {
"type": "object",
"required": [
"type"
],
"properties": {
"addressLine1": {
"description": "The first line of the address.",
"type": "string",
"example": "1600"
},
"addressLine2": {
"description": "The second line of the address.",
"type": "string",
"example": "Amphitheatre Parkway"
},
"city": {
"description": "The city where the company is located.",
"type": "string",
"example": "Mountain View"
},
"state": {
"description": "The state where the company is located.",
"type": "string",
"example": "California"
},
"zipCode": {
"description": "The postal code for the address.",
"type": "string",
"example": "94043"
},
"country": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
},
{
"example": "United States"
}
]
}
}
},
"ClientAddress": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBase"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/AddressType"
}
}
}
]
},
"ClientCompanyAddress": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBase"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CompanyAddressType"
}
}
}
]
},
"ClientShareholder": {
"anyOf": [
{
"$ref": "#/components/schemas/ClientIndividualShareholder"
},
{
"$ref": "#/components/schemas/ClientCorporateShareholder"
}
]
},
"ClientCorporateShareholder": {
"type": "object",
"properties": {
"id": {
"readOnly": true,
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "The unique identifier for the shareholder."
}
]
},
"email": {
"description": "The email address of the shareholder.",
"type": "string",
"example": "anirban@test.com"
},
"percentOwnershipInCompany": {
"description": "The percentage of ownership the shareholder has in the company.",
"type": "number",
"minimum": 0,
"maximum": 100,
"example": 25
},
"ownerType": {
"allOf": [
{
"$ref": "#/components/schemas/OwnerType"
},
{
"example": "CORPORATE"
}
]
},
"businessEntityType": {
"allOf": [
{
"$ref": "#/components/schemas/EntityType"
},
{
"description": "The type of business entity if the shareholder is a corporate."
}
]
},
"businessName": {
"description": "The name of the business if the shareholder is a corporate.",
"type": "string",
"example": "Alphabet"
},
"businessRegistrationNumber": {
"description": "The registration number of the business if the shareholder is a corporate.",
"type": "string",
"example": "JG23517"
},
"ownershipTopology": {
"$ref": "#/components/schemas/OwnershipTopology"
},
"nationality": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
},
{
"description": "The country where the business is registered."
},
{
"example": "United States"
}
]
},
"status": {
"$ref": "#/components/schemas/ShareholderStatus"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/ClientCompanyAddress"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"COMPANY_ADDRESS"
]
}
}
},
{
"description": "The registered business address."
}
]
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiClientShareholderDocument"
}
}
}
},
"ApiClientShareholderDocument": {
"allOf": [
{
"$ref": "#/components/schemas/ApiClientDocumentSchema"
}
],
"type": "object",
"properties": {
"shareholderId": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Shareholder ID"
}
]
}
}
},
"ApiClientDocumentSchema": {
"type": "object",
"required": [
"link",
"typeId"
],
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Document ID"
}
]
},
"typeId": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Document type ID"
}
]
},
"link": {
"description": "Document link",
"type": "string"
},
"country": {
"description": "Country where the document is issued",
"type": "string",
"nullable": true
}
}
},
"ApiClientCompanyDocumentPostRq": {
"discriminator": {
"propertyName": "action",
"mapping": {
"ADD": "#/components/schemas/ApiClientCompanyDocumentAddRq",
"UPDATE": "#/components/schemas/ApiClientCompanyDocumentUpdateRq",
"DELETE": "#/components/schemas/ApiClientCompanyDocumentDeleteRq"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/ApiClientCompanyDocumentAddRq"
},
{
"$ref": "#/components/schemas/ApiClientCompanyDocumentUpdateRq"
},
{
"$ref": "#/components/schemas/ApiClientCompanyDocumentDeleteRq"
}
]
},
"ApiClientCompanyDocumentAddRq": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"type": "string",
"enum": [
"ADD"
],
"description": "Action type for adding a new company document"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApiClientDocumentSchema"
},
{
"type": "object",
"required": [
"typeId",
"link"
],
"description": "Document data with all required fields for adding a new document"
}
]
}
}
},
"ApiClientCompanyDocumentUpdateRq": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"type": "string",
"enum": [
"UPDATE"
],
"description": "Action type for updating an existing company document"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApiClientDocumentSchema"
},
{
"type": "object",
"required": [
"id",
"typeId",
"link"
],
"description": "Document data with ID and all required fields for updating an existing document"
}
]
}
}
},
"ApiClientCompanyDocumentDeleteRq": {
"type": "object",
"required": [
"action",
"data",
"reason"
],
"properties": {
"action": {
"type": "string",
"enum": [
"DELETE"
],
"description": "Action type for deleting a company document"
},
"data": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Document ID to be deleted"
}
]
}
},
"description": "Only ID is required for deletion"
},
"reason": {
"type": "string",
"description": "Required reason for deleting the document",
"minLength": 1
}
}
},
"ApiClientShareholderDocumentPostRq": {
"discriminator": {
"propertyName": "action",
"mapping": {
"ADD": "#/components/schemas/ApiClientShareholderDocumentAddRq",
"UPDATE": "#/components/schemas/ApiClientShareholderDocumentUpdateRq",
"DELETE": "#/components/schemas/ApiClientShareholderDocumentDeleteRq"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/ApiClientShareholderDocumentAddRq"
},
{
"$ref": "#/components/schemas/ApiClientShareholderDocumentUpdateRq"
},
{
"$ref": "#/components/schemas/ApiClientShareholderDocumentDeleteRq"
}
]
},
"ApiClientShareholderDocumentAddRq": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"type": "string",
"enum": [
"ADD"
],
"description": "Action type for adding a new shareholder document"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApiClientShareholderDocument"
},
{
"type": "object",
"required": [
"typeId",
"link",
"shareholderId"
],
"description": "Document data with all required fields for adding a new shareholder document"
}
]
}
}
},
"ApiClientShareholderDocumentUpdateRq": {
"type": "object",
"required": [
"action",
"data"
],
"properties": {
"action": {
"type": "string",
"enum": [
"UPDATE"
],
"description": "Action type for updating an existing shareholder document"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApiClientShareholderDocument"
},
{
"type": "object",
"required": [
"id",
"typeId",
"link",
"shareholderId"
],
"description": "Document data with ID and all required fields for updating an existing shareholder document"
}
]
}
}
},
"ApiClientShareholderDocumentDeleteRq": {
"type": "object",
"required": [
"action",
"data",
"reason"
],
"properties": {
"action": {
"type": "string",
"enum": [
"DELETE"
],
"description": "Action type for deleting a shareholder document"
},
"data": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Document ID to be deleted"
}
]
}
},
"description": "Only ID is required for deletion"
},
"reason": {
"type": "string",
"description": "Required reason for deleting the shareholder document",
"minLength": 1
}
}
},
"ClientIndividualShareholder": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Shareholder ID"
}
]
},
"email": {
"description": "Email of the shareholder",
"type": "string",
"example": "anirban@test.com"
},
"percentOwnershipInCompany": {
"description": "Percentage of ownership in company",
"type": "number",
"minimum": 0,
"maximum": 100,
"example": 25
},
"ownerType": {
"allOf": [
{
"$ref": "#/components/schemas/OwnerType"
}
]
},
"firstName": {
"description": "First name of the shareholder",
"type": "string",
"example": "Anirban"
},
"lastName": {
"description": "Last name of the shareholder",
"type": "string",
"example": "Kar"
},
"nationality": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
},
{
"description": "Country of residence"
},
{
"example": "United States"
}
]
},
"isControllingOfficer": {
"description": "Is the shareholder a director",
"type": "boolean"
},
"ownershipTopology": {
"$ref": "#/components/schemas/OwnershipTopology"
},
"shareholderRole": {
"$ref": "#/components/schemas/ShareholderRole"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"countryCallingCode": {
"description": "Shareholder country calling code",
"type": "string",
"example": "+44"
},
"phoneNumber": {
"description": "Shareholder phone number",
"type": "string",
"pattern": "\\d+",
"example": "12345678"
},
"idNumbers": {
"$ref": "#/components/schemas/IdNumbers"
},
"ipAddress": {
"readOnly": true,
"description": "Shareholder ip address",
"type": "string",
"example": "0.0.0.0"
},
"kycStatus": {
"readOnly": true,
"$ref": "#/components/schemas/EKYCStatus"
},
"kycApprovedOn": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2022-05-14T02:35:53.455+05:30",
"description": "Shareholder kyc approved on"
},
"verificationLink": {
"readOnly": true,
"type": "string"
},
"verificationLinkGeneratedAt": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"status": {
"$ref": "#/components/schemas/ShareholderStatus"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/ClientAddress"
},
{
"description": "Individual shareholder address"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"HOME_ADDRESS"
]
}
}
}
]
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiClientShareholderDocument"
}
}
}
},
"IdNumbers": {
"type": "object",
"description": "object containing all the id numbers",
"properties": {
"bvn": {
"type": "string",
"example": "00000000000"
},
"nin_v2": {
"type": "string",
"example": "00000000000"
},
"tin": {
"type": "string",
"example": "00000000-0000"
}
}
},
"ShareholderStatus": {
"type": "string",
"enum": [
"ACTIVE",
"ARCHIVED"
]
},
"RiskAssessment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnboardingAnswer"
}
},
"OnboardingAnswer": {
"type": "object",
"required": [
"questionId",
"answer"
],
"properties": {
"questionId": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Question ID"
}
]
},
"answer": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"example": "$499K - $1M"
}
}
},
"OnboardingState": {
"description": "Onboarding state",
"type": "string",
"enum": [
"SIGNUP_VERIFICATION",
"BUSINESS_INFORMATION",
"SHAREHOLDER_INFORMATION",
"COMPANY_DOCUMENTS",
"SHAREHOLDER_VERIFICATION",
"RISK_ASSESSMENT"
],
"example": "SIGNUP_VERIFICATION"
},
"OnboardingStatus": {
"description": "Onboarding status",
"type": "string",
"enum": [
"IN_PROGRESS",
"USER_COMPLETED",
"APPROVED",
"REJECTED"
],
"example": "IN_PROGRESS"
},
"PostAction": {
"description": "Specifies the action that will actioned upon the respective object. In case of UPDATE and DELETE, id field is required",
"type": "string",
"enum": [
"ADD",
"UPDATE",
"DELETE"
]
},
"OwnerType": {
"description": "Whether the shareholder is an individual or a corporate",
"type": "string",
"enum": [
"INDIVIDUAL",
"CORPORATE"
]
},
"OwnershipTopology": {
"description": "Whether the ownership is direct or indirect in case shareholder is a corporate",
"type": "string",
"enum": [
"DIRECT",
"INDIRECT"
]
},
"ShareholderRole": {
"description": "Whether the shareholder is a director or not",
"type": "string",
"enum": [
"VP/Exec",
"Director",
"Manager",
"C-Suit",
"Individual Contributor"
]
},
"CompanyAddressType": {
"description": "Specifies the type of address, which can either be `COMPANY_ADDRESS` or `OPERATING_ADDRESS`.",
"type": "string",
"enum": [
"COMPANY_ADDRESS",
"OPERATING_ADDRESS"
],
"example": "COMPANY_ADDRESS"
},
"AddressType": {
"description": "Specifies the type of address, which can be `COMPANY_ADDRESS`, `OPERATING_ADDRESS`, `HOME_ADDRESS`, or `OTHER_ADDRESS`.",
"type": "string",
"enum": [
"COMPANY_ADDRESS",
"OPERATING_ADDRESS",
"HOME_ADDRESS",
"OTHER_ADDRESS"
],
"example": "HOME_ADDRESS"
},
"Uuid": {
"description": "A unique identifier.",
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "5f29833d-1104-42a9-8c63-e6c8140130c1"
},
"EntityType": {
"description": "Describes the type of business entity.",
"type": "string",
"enum": [
"Public Limited Company",
"Private Limited Company",
"Limited Liability Company",
"Sole Trader / Sole Proprietorship / Freelancers",
"Club / Association",
"Non Profit / Charity",
"Estate / Trust",
"Partnerships",
"Unlimited Company",
"Closed Corporation",
"PTY Limited"
],
"example": "Private Limited Company"
},
"AuditableBaseObj": {
"type": "object",
"properties": {
"id": {
"readOnly": true,
"$ref": "#/components/schemas/Uuid"
},
"createdAt": {
"readOnly": true,
"type": "string",
"description": "The date and time when the object was created.",
"format": "date-time",
"example": "2022-05-14T02:35:53.455+05:30"
},
"modifiedAt": {
"readOnly": true,
"type": "string",
"description": "The date and time when the object was last modified.",
"format": "date-time",
"example": "2022-05-14T02:35:53.455+05:30"
},
"modifiedByUserId": {
"readOnly": true,
"type": "string",
"description": "The user ID of the person who last modified the object.",
"example": "1"
}
}
},
"Country": {
"nullable": true,
"description": "The country where the sub-account is registered.",
"type": "string",
"enum": [
null,
"Aland Islands",
"Albania",
"Algeria",
"Andorra",
"Angola",
"Anguilla",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bonaire, Saint Eustatius and Saba",
"Bosnia and Herzegovina",
"Botswana",
"Brazil",
"British Indian Ocean Territory",
"British Virgin Islands",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Cambodia",
"Cameroon",
"Canada",
"Cape Verde",
"Cayman Islands",
"Chad",
"Chile",
"China",
"Chinese Taipei",
"Christmas Island",
"Cocos Islands",
"Colombia",
"Comoros",
"Cook Islands",
"Costa Rica",
"Cote D'Ivoire",
"Curacao",
"Cyprus",
"Czech Republic",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"Dominican Republic",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Falkland Islands",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"Gabon",
"Gambia",
"Gaza Strip",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guyana",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Ivory Coast",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Kuwait",
"Kyrgyzstan",
"Laos",
"Latvia",
"Lesotho",
"Liberia",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Macau",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Malta",
"Marshall Islands",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Moldova",
"Monaco",
"Mongolia",
"Montserrat",
"Morocco",
"Mozambique",
"Namibia",
"Nauru",
"Nepal",
"Netherlands",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestinian Territory",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn",
"Poland",
"Portugal",
"Puerto Rico",
"Puerto Rico",
"Qatar",
"Reunion",
"Romania",
"Rwanda",
"Saint Barthelemy",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Martin",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Samoa",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Seychelles",
"Sierra Leone",
"Singapore",
"Sint Maarten",
"Slovakia",
"Solomon Islands",
"South Africa",
"South Korea",
"Spain",
"Sri Lanka",
"Suriname",
"Svalbard and Jan Mayen",
"Swaziland",
"Sweden",
"Switzerland",
"Taiwan",
"Tajikistan",
"Tanzania",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"U.S. Virgin Islands",
"Uganda",
"United Arab Emirates",
"United Kingdom",
"United States",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Vatican",
"Vietnam",
"Wallis and Futuna",
"Western Sahara",
"Zambia"
]
},
"EKYCStatus": {
"type": "string",
"description": "Status of the kyc verification process",
"enum": [
"PENDING",
"IN_PROGRESS",
"USER_COMPLETED",
"MANUAL_REVIEW",
"APPROVED",
"REJECTED",
"RESUBMISSION_REQUESTED"
]
}
}
}
}
```