Submit Business Profile

cURL

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/kyb \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "businessName": "<string>",
  "incorporationDate": "2023-12-25",
  "incorporationCountry": "<string>",
  "businessAddress": {
    "streetLine1": "Av. Reforma 123",
    "city": "CDMX",
    "state": "CDMX",
    "postalCode": "06600",
    "country": "MX",
    "streetLine2": "<string>"
  },
  "termsAndConditionsAcceptance": {
    "dateTime": "2023-11-07T05:31:56Z"
  },
  "businessModelDescription": "<string>",
  "sourceOfFunds": [],
  "accountPurpose": [],
  "licenses": [],
  "counterpartyCountries": [
    "<string>"
  ],
  "operatingCountries": [
    "<string>"
  ],
  "highRiskIndustryExposure": true,
  "asiaExposure": true,
  "capaProducts": [],
  "regulatedCountries": [
    "<string>"
  ],
  "businessRegistrationDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "addressProofDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "bankStatementDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "directorsRegistry": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "articlesOfIncorporation": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "shareholdersRegistry": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "taxRegistrationCertificate": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "relatedPersons": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "1990-01-01",
      "roles": [],
      "address": {
        "streetLine1": "Av. Reforma 123",
        "city": "CDMX",
        "state": "CDMX",
        "postalCode": "06600",
        "country": "MX",
        "streetLine2": "<string>"
      },
      "relationWithCompany": "Founder",
      "positionInCompany": "CEO",
      "taxId": "<string>",
      "sourceOfFunds": [
        "<string>"
      ],
      "photoIdDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
      },
      "addressProofDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
      },
      "middleName": "<string>",
      "phoneNumber": "+525512345678",
      "email": "jsmith@example.com",
      "ownershipPercent": 50,
      "sharesAllocated": 1
    }
  ],
  "dbaName": "<string>",
  "taxId": "<string>",
  "website": "<string>",
  "registrationEntityId": "<string>",
  "stateCode": "<string>",
  "contactPhone": "<string>",
  "contactEmail": "jsmith@example.com",
  "industryOtherDescription": "<string>",
  "financialServicesSubtype": "<string>",
  "legalEntityTypeOtherDescription": "<string>",
  "sourceOfFundsOtherDescription": "<string>",
  "accountPurposeOtherDescription": "<string>",
  "licensesOtherDescription": "<string>",
  "primaryTargetMarketOtherDescription": "<string>",
  "highRiskIndustries": [],
  "highRiskActivityDescription": "<string>",
  "asiaExposureCountries": [
    "<string>"
  ],
  "isUsMsb": true,
  "usMsbCategories": [],
  "usMsbCategoriesOtherDescription": "<string>",
  "msbVirtualAssetSubtype": "<string>",
  "msbServiceDescription": "<string>",
  "mxAnnex7ASubtype": "<string>",
  "mxVulnerableActivityOrLicense": true,
  "mxVulnerableActivityDescription": "<string>",
  "mxEconomicActivity": "<string>"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/kyb"

payload = {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessName": "<string>",
    "incorporationDate": "2023-12-25",
    "incorporationCountry": "<string>",
    "businessAddress": {
        "streetLine1": "Av. Reforma 123",
        "city": "CDMX",
        "state": "CDMX",
        "postalCode": "06600",
        "country": "MX",
        "streetLine2": "<string>"
    },
    "termsAndConditionsAcceptance": { "dateTime": "2023-11-07T05:31:56Z" },
    "businessModelDescription": "<string>",
    "sourceOfFunds": [],
    "accountPurpose": [],
    "licenses": [],
    "counterpartyCountries": ["<string>"],
    "operatingCountries": ["<string>"],
    "highRiskIndustryExposure": True,
    "asiaExposure": True,
    "capaProducts": [],
    "regulatedCountries": ["<string>"],
    "businessRegistrationDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "addressProofDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "bankStatementDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "directorsRegistry": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "articlesOfIncorporation": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "shareholdersRegistry": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "taxRegistrationCertificate": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "relatedPersons": [
        {
            "firstName": "<string>",
            "lastName": "<string>",
            "dateOfBirth": "1990-01-01",
            "roles": [],
            "address": {
                "streetLine1": "Av. Reforma 123",
                "city": "CDMX",
                "state": "CDMX",
                "postalCode": "06600",
                "country": "MX",
                "streetLine2": "<string>"
            },
            "relationWithCompany": "Founder",
            "positionInCompany": "CEO",
            "taxId": "<string>",
            "sourceOfFunds": ["<string>"],
            "photoIdDocument": {
                "fileName": "articles_of_incorporation.pdf",
                "fileBase64": "<string>"
            },
            "addressProofDocument": {
                "fileName": "articles_of_incorporation.pdf",
                "fileBase64": "<string>"
            },
            "middleName": "<string>",
            "phoneNumber": "+525512345678",
            "email": "jsmith@example.com",
            "ownershipPercent": 50,
            "sharesAllocated": 1
        }
    ],
    "dbaName": "<string>",
    "taxId": "<string>",
    "website": "<string>",
    "registrationEntityId": "<string>",
    "stateCode": "<string>",
    "contactPhone": "<string>",
    "contactEmail": "jsmith@example.com",
    "industryOtherDescription": "<string>",
    "financialServicesSubtype": "<string>",
    "legalEntityTypeOtherDescription": "<string>",
    "sourceOfFundsOtherDescription": "<string>",
    "accountPurposeOtherDescription": "<string>",
    "licensesOtherDescription": "<string>",
    "primaryTargetMarketOtherDescription": "<string>",
    "highRiskIndustries": [],
    "highRiskActivityDescription": "<string>",
    "asiaExposureCountries": ["<string>"],
    "isUsMsb": True,
    "usMsbCategories": [],
    "usMsbCategoriesOtherDescription": "<string>",
    "msbVirtualAssetSubtype": "<string>",
    "msbServiceDescription": "<string>",
    "mxAnnex7ASubtype": "<string>",
    "mxVulnerableActivityOrLicense": True,
    "mxVulnerableActivityDescription": "<string>",
    "mxEconomicActivity": "<string>"
}
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    businessName: '<string>',
    incorporationDate: '2023-12-25',
    incorporationCountry: '<string>',
    businessAddress: {
      streetLine1: 'Av. Reforma 123',
      city: 'CDMX',
      state: 'CDMX',
      postalCode: '06600',
      country: 'MX',
      streetLine2: '<string>'
    },
    termsAndConditionsAcceptance: {dateTime: '2023-11-07T05:31:56Z'},
    businessModelDescription: '<string>',
    sourceOfFunds: [],
    accountPurpose: [],
    licenses: [],
    counterpartyCountries: ['<string>'],
    operatingCountries: ['<string>'],
    highRiskIndustryExposure: true,
    asiaExposure: true,
    capaProducts: [],
    regulatedCountries: ['<string>'],
    businessRegistrationDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    addressProofDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    bankStatementDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    directorsRegistry: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    articlesOfIncorporation: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    shareholdersRegistry: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    taxRegistrationCertificate: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    relatedPersons: [
      {
        firstName: '<string>',
        lastName: '<string>',
        dateOfBirth: '1990-01-01',
        roles: [],
        address: {
          streetLine1: 'Av. Reforma 123',
          city: 'CDMX',
          state: 'CDMX',
          postalCode: '06600',
          country: 'MX',
          streetLine2: '<string>'
        },
        relationWithCompany: 'Founder',
        positionInCompany: 'CEO',
        taxId: '<string>',
        sourceOfFunds: ['<string>'],
        photoIdDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
        addressProofDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
        middleName: '<string>',
        phoneNumber: '+525512345678',
        email: 'jsmith@example.com',
        ownershipPercent: 50,
        sharesAllocated: 1
      }
    ],
    dbaName: '<string>',
    taxId: '<string>',
    website: '<string>',
    registrationEntityId: '<string>',
    stateCode: '<string>',
    contactPhone: '<string>',
    contactEmail: 'jsmith@example.com',
    industryOtherDescription: '<string>',
    financialServicesSubtype: '<string>',
    legalEntityTypeOtherDescription: '<string>',
    sourceOfFundsOtherDescription: '<string>',
    accountPurposeOtherDescription: '<string>',
    licensesOtherDescription: '<string>',
    primaryTargetMarketOtherDescription: '<string>',
    highRiskIndustries: [],
    highRiskActivityDescription: '<string>',
    asiaExposureCountries: ['<string>'],
    isUsMsb: true,
    usMsbCategories: [],
    usMsbCategoriesOtherDescription: '<string>',
    msbVirtualAssetSubtype: '<string>',
    msbServiceDescription: '<string>',
    mxAnnex7ASubtype: '<string>',
    mxVulnerableActivityOrLicense: true,
    mxVulnerableActivityDescription: '<string>',
    mxEconomicActivity: '<string>'
  })
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/kyb', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/kyb",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'businessName' => '<string>',
    'incorporationDate' => '2023-12-25',
    'incorporationCountry' => '<string>',
    'businessAddress' => [
        'streetLine1' => 'Av. Reforma 123',
        'city' => 'CDMX',
        'state' => 'CDMX',
        'postalCode' => '06600',
        'country' => 'MX',
        'streetLine2' => '<string>'
    ],
    'termsAndConditionsAcceptance' => [
        'dateTime' => '2023-11-07T05:31:56Z'
    ],
    'businessModelDescription' => '<string>',
    'sourceOfFunds' => [
        
    ],
    'accountPurpose' => [
        
    ],
    'licenses' => [
        
    ],
    'counterpartyCountries' => [
        '<string>'
    ],
    'operatingCountries' => [
        '<string>'
    ],
    'highRiskIndustryExposure' => true,
    'asiaExposure' => true,
    'capaProducts' => [
        
    ],
    'regulatedCountries' => [
        '<string>'
    ],
    'businessRegistrationDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'addressProofDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'bankStatementDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'directorsRegistry' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'articlesOfIncorporation' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'shareholdersRegistry' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'taxRegistrationCertificate' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'relatedPersons' => [
        [
                'firstName' => '<string>',
                'lastName' => '<string>',
                'dateOfBirth' => '1990-01-01',
                'roles' => [
                                
                ],
                'address' => [
                                'streetLine1' => 'Av. Reforma 123',
                                'city' => 'CDMX',
                                'state' => 'CDMX',
                                'postalCode' => '06600',
                                'country' => 'MX',
                                'streetLine2' => '<string>'
                ],
                'relationWithCompany' => 'Founder',
                'positionInCompany' => 'CEO',
                'taxId' => '<string>',
                'sourceOfFunds' => [
                                '<string>'
                ],
                'photoIdDocument' => [
                                'fileName' => 'articles_of_incorporation.pdf',
                                'fileBase64' => '<string>'
                ],
                'addressProofDocument' => [
                                'fileName' => 'articles_of_incorporation.pdf',
                                'fileBase64' => '<string>'
                ],
                'middleName' => '<string>',
                'phoneNumber' => '+525512345678',
                'email' => 'jsmith@example.com',
                'ownershipPercent' => 50,
                'sharesAllocated' => 1
        ]
    ],
    'dbaName' => '<string>',
    'taxId' => '<string>',
    'website' => '<string>',
    'registrationEntityId' => '<string>',
    'stateCode' => '<string>',
    'contactPhone' => '<string>',
    'contactEmail' => 'jsmith@example.com',
    'industryOtherDescription' => '<string>',
    'financialServicesSubtype' => '<string>',
    'legalEntityTypeOtherDescription' => '<string>',
    'sourceOfFundsOtherDescription' => '<string>',
    'accountPurposeOtherDescription' => '<string>',
    'licensesOtherDescription' => '<string>',
    'primaryTargetMarketOtherDescription' => '<string>',
    'highRiskIndustries' => [
        
    ],
    'highRiskActivityDescription' => '<string>',
    'asiaExposureCountries' => [
        '<string>'
    ],
    'isUsMsb' => true,
    'usMsbCategories' => [
        
    ],
    'usMsbCategoriesOtherDescription' => '<string>',
    'msbVirtualAssetSubtype' => '<string>',
    'msbServiceDescription' => '<string>',
    'mxAnnex7ASubtype' => '<string>',
    'mxVulnerableActivityOrLicense' => true,
    'mxVulnerableActivityDescription' => '<string>',
    'mxEconomicActivity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/kyb"

	payload := strings.NewReader("{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("partner-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.capa.fi/api/partner/v2/kyb")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/kyb")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "verificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "status": "IN_PROGRESS",
    "submissionStage": "DRAFT",
    "country": "MX",
    "createdAt": "2026-08-26T00:00:00.000Z",
    "updatedAt": "2026-08-26T00:00:00.000Z"
  }
}

POST

api

partner

kyb

cURL

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/kyb \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "businessName": "<string>",
  "incorporationDate": "2023-12-25",
  "incorporationCountry": "<string>",
  "businessAddress": {
    "streetLine1": "Av. Reforma 123",
    "city": "CDMX",
    "state": "CDMX",
    "postalCode": "06600",
    "country": "MX",
    "streetLine2": "<string>"
  },
  "termsAndConditionsAcceptance": {
    "dateTime": "2023-11-07T05:31:56Z"
  },
  "businessModelDescription": "<string>",
  "sourceOfFunds": [],
  "accountPurpose": [],
  "licenses": [],
  "counterpartyCountries": [
    "<string>"
  ],
  "operatingCountries": [
    "<string>"
  ],
  "highRiskIndustryExposure": true,
  "asiaExposure": true,
  "capaProducts": [],
  "regulatedCountries": [
    "<string>"
  ],
  "businessRegistrationDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "addressProofDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "bankStatementDocument": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "directorsRegistry": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "articlesOfIncorporation": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "shareholdersRegistry": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "taxRegistrationCertificate": {
    "fileName": "articles_of_incorporation.pdf",
    "fileBase64": "<string>"
  },
  "relatedPersons": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "1990-01-01",
      "roles": [],
      "address": {
        "streetLine1": "Av. Reforma 123",
        "city": "CDMX",
        "state": "CDMX",
        "postalCode": "06600",
        "country": "MX",
        "streetLine2": "<string>"
      },
      "relationWithCompany": "Founder",
      "positionInCompany": "CEO",
      "taxId": "<string>",
      "sourceOfFunds": [
        "<string>"
      ],
      "photoIdDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
      },
      "addressProofDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
      },
      "middleName": "<string>",
      "phoneNumber": "+525512345678",
      "email": "jsmith@example.com",
      "ownershipPercent": 50,
      "sharesAllocated": 1
    }
  ],
  "dbaName": "<string>",
  "taxId": "<string>",
  "website": "<string>",
  "registrationEntityId": "<string>",
  "stateCode": "<string>",
  "contactPhone": "<string>",
  "contactEmail": "jsmith@example.com",
  "industryOtherDescription": "<string>",
  "financialServicesSubtype": "<string>",
  "legalEntityTypeOtherDescription": "<string>",
  "sourceOfFundsOtherDescription": "<string>",
  "accountPurposeOtherDescription": "<string>",
  "licensesOtherDescription": "<string>",
  "primaryTargetMarketOtherDescription": "<string>",
  "highRiskIndustries": [],
  "highRiskActivityDescription": "<string>",
  "asiaExposureCountries": [
    "<string>"
  ],
  "isUsMsb": true,
  "usMsbCategories": [],
  "usMsbCategoriesOtherDescription": "<string>",
  "msbVirtualAssetSubtype": "<string>",
  "msbServiceDescription": "<string>",
  "mxAnnex7ASubtype": "<string>",
  "mxVulnerableActivityOrLicense": true,
  "mxVulnerableActivityDescription": "<string>",
  "mxEconomicActivity": "<string>"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/kyb"

payload = {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessName": "<string>",
    "incorporationDate": "2023-12-25",
    "incorporationCountry": "<string>",
    "businessAddress": {
        "streetLine1": "Av. Reforma 123",
        "city": "CDMX",
        "state": "CDMX",
        "postalCode": "06600",
        "country": "MX",
        "streetLine2": "<string>"
    },
    "termsAndConditionsAcceptance": { "dateTime": "2023-11-07T05:31:56Z" },
    "businessModelDescription": "<string>",
    "sourceOfFunds": [],
    "accountPurpose": [],
    "licenses": [],
    "counterpartyCountries": ["<string>"],
    "operatingCountries": ["<string>"],
    "highRiskIndustryExposure": True,
    "asiaExposure": True,
    "capaProducts": [],
    "regulatedCountries": ["<string>"],
    "businessRegistrationDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "addressProofDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "bankStatementDocument": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "directorsRegistry": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "articlesOfIncorporation": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "shareholdersRegistry": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "taxRegistrationCertificate": {
        "fileName": "articles_of_incorporation.pdf",
        "fileBase64": "<string>"
    },
    "relatedPersons": [
        {
            "firstName": "<string>",
            "lastName": "<string>",
            "dateOfBirth": "1990-01-01",
            "roles": [],
            "address": {
                "streetLine1": "Av. Reforma 123",
                "city": "CDMX",
                "state": "CDMX",
                "postalCode": "06600",
                "country": "MX",
                "streetLine2": "<string>"
            },
            "relationWithCompany": "Founder",
            "positionInCompany": "CEO",
            "taxId": "<string>",
            "sourceOfFunds": ["<string>"],
            "photoIdDocument": {
                "fileName": "articles_of_incorporation.pdf",
                "fileBase64": "<string>"
            },
            "addressProofDocument": {
                "fileName": "articles_of_incorporation.pdf",
                "fileBase64": "<string>"
            },
            "middleName": "<string>",
            "phoneNumber": "+525512345678",
            "email": "jsmith@example.com",
            "ownershipPercent": 50,
            "sharesAllocated": 1
        }
    ],
    "dbaName": "<string>",
    "taxId": "<string>",
    "website": "<string>",
    "registrationEntityId": "<string>",
    "stateCode": "<string>",
    "contactPhone": "<string>",
    "contactEmail": "jsmith@example.com",
    "industryOtherDescription": "<string>",
    "financialServicesSubtype": "<string>",
    "legalEntityTypeOtherDescription": "<string>",
    "sourceOfFundsOtherDescription": "<string>",
    "accountPurposeOtherDescription": "<string>",
    "licensesOtherDescription": "<string>",
    "primaryTargetMarketOtherDescription": "<string>",
    "highRiskIndustries": [],
    "highRiskActivityDescription": "<string>",
    "asiaExposureCountries": ["<string>"],
    "isUsMsb": True,
    "usMsbCategories": [],
    "usMsbCategoriesOtherDescription": "<string>",
    "msbVirtualAssetSubtype": "<string>",
    "msbServiceDescription": "<string>",
    "mxAnnex7ASubtype": "<string>",
    "mxVulnerableActivityOrLicense": True,
    "mxVulnerableActivityDescription": "<string>",
    "mxEconomicActivity": "<string>"
}
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    businessName: '<string>',
    incorporationDate: '2023-12-25',
    incorporationCountry: '<string>',
    businessAddress: {
      streetLine1: 'Av. Reforma 123',
      city: 'CDMX',
      state: 'CDMX',
      postalCode: '06600',
      country: 'MX',
      streetLine2: '<string>'
    },
    termsAndConditionsAcceptance: {dateTime: '2023-11-07T05:31:56Z'},
    businessModelDescription: '<string>',
    sourceOfFunds: [],
    accountPurpose: [],
    licenses: [],
    counterpartyCountries: ['<string>'],
    operatingCountries: ['<string>'],
    highRiskIndustryExposure: true,
    asiaExposure: true,
    capaProducts: [],
    regulatedCountries: ['<string>'],
    businessRegistrationDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    addressProofDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    bankStatementDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    directorsRegistry: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    articlesOfIncorporation: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    shareholdersRegistry: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    taxRegistrationCertificate: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
    relatedPersons: [
      {
        firstName: '<string>',
        lastName: '<string>',
        dateOfBirth: '1990-01-01',
        roles: [],
        address: {
          streetLine1: 'Av. Reforma 123',
          city: 'CDMX',
          state: 'CDMX',
          postalCode: '06600',
          country: 'MX',
          streetLine2: '<string>'
        },
        relationWithCompany: 'Founder',
        positionInCompany: 'CEO',
        taxId: '<string>',
        sourceOfFunds: ['<string>'],
        photoIdDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
        addressProofDocument: {fileName: 'articles_of_incorporation.pdf', fileBase64: '<string>'},
        middleName: '<string>',
        phoneNumber: '+525512345678',
        email: 'jsmith@example.com',
        ownershipPercent: 50,
        sharesAllocated: 1
      }
    ],
    dbaName: '<string>',
    taxId: '<string>',
    website: '<string>',
    registrationEntityId: '<string>',
    stateCode: '<string>',
    contactPhone: '<string>',
    contactEmail: 'jsmith@example.com',
    industryOtherDescription: '<string>',
    financialServicesSubtype: '<string>',
    legalEntityTypeOtherDescription: '<string>',
    sourceOfFundsOtherDescription: '<string>',
    accountPurposeOtherDescription: '<string>',
    licensesOtherDescription: '<string>',
    primaryTargetMarketOtherDescription: '<string>',
    highRiskIndustries: [],
    highRiskActivityDescription: '<string>',
    asiaExposureCountries: ['<string>'],
    isUsMsb: true,
    usMsbCategories: [],
    usMsbCategoriesOtherDescription: '<string>',
    msbVirtualAssetSubtype: '<string>',
    msbServiceDescription: '<string>',
    mxAnnex7ASubtype: '<string>',
    mxVulnerableActivityOrLicense: true,
    mxVulnerableActivityDescription: '<string>',
    mxEconomicActivity: '<string>'
  })
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/kyb', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/kyb",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'businessName' => '<string>',
    'incorporationDate' => '2023-12-25',
    'incorporationCountry' => '<string>',
    'businessAddress' => [
        'streetLine1' => 'Av. Reforma 123',
        'city' => 'CDMX',
        'state' => 'CDMX',
        'postalCode' => '06600',
        'country' => 'MX',
        'streetLine2' => '<string>'
    ],
    'termsAndConditionsAcceptance' => [
        'dateTime' => '2023-11-07T05:31:56Z'
    ],
    'businessModelDescription' => '<string>',
    'sourceOfFunds' => [
        
    ],
    'accountPurpose' => [
        
    ],
    'licenses' => [
        
    ],
    'counterpartyCountries' => [
        '<string>'
    ],
    'operatingCountries' => [
        '<string>'
    ],
    'highRiskIndustryExposure' => true,
    'asiaExposure' => true,
    'capaProducts' => [
        
    ],
    'regulatedCountries' => [
        '<string>'
    ],
    'businessRegistrationDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'addressProofDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'bankStatementDocument' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'directorsRegistry' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'articlesOfIncorporation' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'shareholdersRegistry' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'taxRegistrationCertificate' => [
        'fileName' => 'articles_of_incorporation.pdf',
        'fileBase64' => '<string>'
    ],
    'relatedPersons' => [
        [
                'firstName' => '<string>',
                'lastName' => '<string>',
                'dateOfBirth' => '1990-01-01',
                'roles' => [
                                
                ],
                'address' => [
                                'streetLine1' => 'Av. Reforma 123',
                                'city' => 'CDMX',
                                'state' => 'CDMX',
                                'postalCode' => '06600',
                                'country' => 'MX',
                                'streetLine2' => '<string>'
                ],
                'relationWithCompany' => 'Founder',
                'positionInCompany' => 'CEO',
                'taxId' => '<string>',
                'sourceOfFunds' => [
                                '<string>'
                ],
                'photoIdDocument' => [
                                'fileName' => 'articles_of_incorporation.pdf',
                                'fileBase64' => '<string>'
                ],
                'addressProofDocument' => [
                                'fileName' => 'articles_of_incorporation.pdf',
                                'fileBase64' => '<string>'
                ],
                'middleName' => '<string>',
                'phoneNumber' => '+525512345678',
                'email' => 'jsmith@example.com',
                'ownershipPercent' => 50,
                'sharesAllocated' => 1
        ]
    ],
    'dbaName' => '<string>',
    'taxId' => '<string>',
    'website' => '<string>',
    'registrationEntityId' => '<string>',
    'stateCode' => '<string>',
    'contactPhone' => '<string>',
    'contactEmail' => 'jsmith@example.com',
    'industryOtherDescription' => '<string>',
    'financialServicesSubtype' => '<string>',
    'legalEntityTypeOtherDescription' => '<string>',
    'sourceOfFundsOtherDescription' => '<string>',
    'accountPurposeOtherDescription' => '<string>',
    'licensesOtherDescription' => '<string>',
    'primaryTargetMarketOtherDescription' => '<string>',
    'highRiskIndustries' => [
        
    ],
    'highRiskActivityDescription' => '<string>',
    'asiaExposureCountries' => [
        '<string>'
    ],
    'isUsMsb' => true,
    'usMsbCategories' => [
        
    ],
    'usMsbCategoriesOtherDescription' => '<string>',
    'msbVirtualAssetSubtype' => '<string>',
    'msbServiceDescription' => '<string>',
    'mxAnnex7ASubtype' => '<string>',
    'mxVulnerableActivityOrLicense' => true,
    'mxVulnerableActivityDescription' => '<string>',
    'mxEconomicActivity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/kyb"

	payload := strings.NewReader("{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("partner-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.capa.fi/api/partner/v2/kyb")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/kyb")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"businessName\": \"<string>\",\n  \"incorporationDate\": \"2023-12-25\",\n  \"incorporationCountry\": \"<string>\",\n  \"businessAddress\": {\n    \"streetLine1\": \"Av. Reforma 123\",\n    \"city\": \"CDMX\",\n    \"state\": \"CDMX\",\n    \"postalCode\": \"06600\",\n    \"country\": \"MX\",\n    \"streetLine2\": \"<string>\"\n  },\n  \"termsAndConditionsAcceptance\": {\n    \"dateTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"businessModelDescription\": \"<string>\",\n  \"sourceOfFunds\": [],\n  \"accountPurpose\": [],\n  \"licenses\": [],\n  \"counterpartyCountries\": [\n    \"<string>\"\n  ],\n  \"operatingCountries\": [\n    \"<string>\"\n  ],\n  \"highRiskIndustryExposure\": true,\n  \"asiaExposure\": true,\n  \"capaProducts\": [],\n  \"regulatedCountries\": [\n    \"<string>\"\n  ],\n  \"businessRegistrationDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"addressProofDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"bankStatementDocument\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"directorsRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"articlesOfIncorporation\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"shareholdersRegistry\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"taxRegistrationCertificate\": {\n    \"fileName\": \"articles_of_incorporation.pdf\",\n    \"fileBase64\": \"<string>\"\n  },\n  \"relatedPersons\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"dateOfBirth\": \"1990-01-01\",\n      \"roles\": [],\n      \"address\": {\n        \"streetLine1\": \"Av. Reforma 123\",\n        \"city\": \"CDMX\",\n        \"state\": \"CDMX\",\n        \"postalCode\": \"06600\",\n        \"country\": \"MX\",\n        \"streetLine2\": \"<string>\"\n      },\n      \"relationWithCompany\": \"Founder\",\n      \"positionInCompany\": \"CEO\",\n      \"taxId\": \"<string>\",\n      \"sourceOfFunds\": [\n        \"<string>\"\n      ],\n      \"photoIdDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"addressProofDocument\": {\n        \"fileName\": \"articles_of_incorporation.pdf\",\n        \"fileBase64\": \"<string>\"\n      },\n      \"middleName\": \"<string>\",\n      \"phoneNumber\": \"+525512345678\",\n      \"email\": \"jsmith@example.com\",\n      \"ownershipPercent\": 50,\n      \"sharesAllocated\": 1\n    }\n  ],\n  \"dbaName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"registrationEntityId\": \"<string>\",\n  \"stateCode\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"contactEmail\": \"jsmith@example.com\",\n  \"industryOtherDescription\": \"<string>\",\n  \"financialServicesSubtype\": \"<string>\",\n  \"legalEntityTypeOtherDescription\": \"<string>\",\n  \"sourceOfFundsOtherDescription\": \"<string>\",\n  \"accountPurposeOtherDescription\": \"<string>\",\n  \"licensesOtherDescription\": \"<string>\",\n  \"primaryTargetMarketOtherDescription\": \"<string>\",\n  \"highRiskIndustries\": [],\n  \"highRiskActivityDescription\": \"<string>\",\n  \"asiaExposureCountries\": [\n    \"<string>\"\n  ],\n  \"isUsMsb\": true,\n  \"usMsbCategories\": [],\n  \"usMsbCategoriesOtherDescription\": \"<string>\",\n  \"msbVirtualAssetSubtype\": \"<string>\",\n  \"msbServiceDescription\": \"<string>\",\n  \"mxAnnex7ASubtype\": \"<string>\",\n  \"mxVulnerableActivityOrLicense\": true,\n  \"mxVulnerableActivityDescription\": \"<string>\",\n  \"mxEconomicActivity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "verificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "status": "IN_PROGRESS",
    "submissionStage": "DRAFT",
    "country": "MX",
    "createdAt": "2026-08-26T00:00:00.000Z",
    "updatedAt": "2026-08-26T00:00:00.000Z"
  }
}

Submits a business’s KYB (Know Your Business) data for verification. The endpoint accepts the submission and returns immediately with 202 Accepted — the underlying AiPrise call chain (session creation, business profile creation, questionnaire, document uploads, related-person verification, and running the verification) is driven asynchronously in the background. Poll GET /details to track progress and retrieve the final verification result.

Important Notes

This endpoint always returns 202 Accepted with submissionStage: "DRAFT" and no externalResourceId — the AiPrise call chain hasn’t started yet at response time.
Only one KYB submission can be in progress per user at a time. Submitting again while a prior submission is IN_PROGRESS returns the existing verification instead of creating a new one.
An optional Idempotency-Key header (16–128 printable ASCII characters) protects against duplicate submissions from client-side retries — a repeated request with the same key and body replays the original response instead of processing twice.
country accepts MX, US, DO, or any SEPA-region country code for EUR-market businesses.
Several fields are conditionally required based on other answers (e.g. isUsMsb fields only apply when country is US; mx* fields only apply when country is MX) — see each field’s description in the schema.
Every relatedPersons entry represents a UBO, director, authorized representative, controlling person, or legal representative — at least one is required. taxRegistrationDocument, beneficialOwnerDeclarationDocument, and accountStatementDocument are optional per person and only relevant in specific markets/products (see field descriptions).
All document fields expect base64-encoded file content (fileBase64) alongside a fileName.

Use Cases

Business onboarding: Collect and submit a business’s full KYB questionnaire and supporting documents in a single call without blocking on AiPrise’s processing time.
Status tracking: Combine with GET /details to build a progress UI for partners while the verification runs in the background.

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

User Ownership Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”Partner information is required for this operation”
401	`UNAUTHORIZED`	”User is not associated with the partner”

Idempotency Errors

HTTP Status	Code	Message
400	`BAD_REQUEST`	”Idempotency-Key ”…” must be 16–128 printable ASCII characters”
409	`CONFLICT`	”Idempotency-Key was already used with a different request body”

Endpoint-Specific Errors

HTTP Status	Code	Message
400	`BAD_REQUEST`	Request body validation failure (missing/invalid field)
422	`UNPROCESSABLE_ENTITY`	”KYB submission requires a BUSINESS user”
500	`INTERNAL_SERVER_ERROR`	”Internal server error”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Headers

Idempotency-Key

string

Optional client-generated key (16-128 printable ASCII characters). If provided, a retried request with the same key and body replays the original response instead of creating a second submission.

Example:

"b7e1c2b0-2f3a-4a5b-9c0e-1a2b3c4d5e6f"

Body

application/json

userId

string<uuid>

required

country

enum<string>

required

Also accepts any SEPA-region ISO alpha-2 code for EUR-market businesses.

Available options:

MX,

US,

DO

businessName

string

required

incorporationDate

string<date>

required

incorporationCountry

string

required

ISO 3166-1 alpha-2.

businessAddress

object

required

Show child attributes

termsAndConditionsAcceptance

object

required

Show child attributes

industry

enum<string>

required

Available options:

Financial services,

Crypto / digital assets,

Technology,

Real estate,

Construction,

Energy,

Entertainment,

Health,

Professional services,

Trade / commerce,

Gambling / gaming,

Non-profit,

Government,

Other

legalEntityType

enum<string>

required

Available options:

Limited Liability Company (LLC),

Corporation,

Partnership,

Sole proprietorship,

Non-profit organization,

Other

businessModelDescription

string

required

Minimum string length: 100

sourceOfFunds

enum<string>[]

required

Minimum array length: 1

Available options:

Business revenue,

Employment income,

Investment income,

Loans / financing,

Donations,

Third-party funds,

Other

accountPurpose

enum<string>[]

required

Minimum array length: 1

Available options:

Business operations,

Payroll,

Cross-border payments,

Domestic payments,

Personal remittances,

Investment,

Treasury management,

Third-party money transmission,

Charitable / donations,

Personal expenses,

Other

licenses

enum<string>[]

required

Minimum array length: 1

Available options:

Money Services Business (MSB),

Money transmitter license,

Virtual Asset Service Provider (VASP),

Crypto-Asset Service Provider (CASP / MiCA),

Electronic Money Institution (EMI),

Payment institution (PSD2),

Banking license,

Broker-dealer license,

Trust company,

None / not applicable,

Other

counterpartyCountries

string[]

required

Minimum array length: 1

expectedFiatMonthlyVolume

enum<string>

required

Available options:

Less than $5,000 USD,

$5,000 – $50,000 USD,

$50,000 – $500,000 USD,

$500,000 – $5,000,000 USD,

More than $5,000,000 USD

expectedCryptoMonthlyVolume

enum<string>

required

Available options:

No crypto activity,

Less than $5,000 USD,

$5,000 – $50,000 USD,

$50,000 – $500,000 USD,

$500,000 – $5,000,000 USD,

More than $5,000,000 USD

primaryTargetMarket

enum<string>

required

Available options:

Commercial (businesses),

Retail (individual consumers),

Government,

Other

expectedCryptoMonthlyOperationCount

enum<string>

required

Available options:

0-100,

101-200,

201<

expectedFiatMonthlyOperationCount

enum<string>

required

Available options:

0-100,

100-200,

201<

operatingCountries

string[]

required

Minimum array length: 1

highRiskIndustryExposure

boolean

required

asiaExposure

boolean

required

capaProducts

enum<string>[]

required

Minimum array length: 1

Available options:

Stablecoin FX,

International Payments

regulatedCountries

string[]

required

Minimum array length: 1

businessRegistrationDocument

object

required

Show child attributes

addressProofDocument

object

required

Show child attributes

bankStatementDocument

object

required

Show child attributes

directorsRegistry

object

required

Show child attributes

articlesOfIncorporation

object

required

Show child attributes

shareholdersRegistry

object

required

Show child attributes

taxRegistrationCertificate

object

required

Show child attributes

Minimum array length: 1

Show child attributes

dbaName

string

taxId

string

website

string<uri>

registrationEntityId

string

stateCode

string

registeredAddress

object

Only if different from businessAddress.

Show child attributes

contactPhone

string

contactEmail

string<email>

industryOtherDescription

string

Required if industry is "Other".

financialServicesSubtype

string

Required if industry is "Financial services".

cryptoSubtype

enum<string>

Required if industry is "Crypto / digital assets".

Available options:

Protocol,

Exchange,

Investment,

Lending,

Market maker,

SaaS,

Mining,

Custody,

Virtual asset service provider (VASP),

Other

legalEntityTypeOtherDescription

string

Required if legalEntityType is "Other".

sourceOfFundsOtherDescription

string

Required if sourceOfFunds includes "Other".

accountPurposeOtherDescription

string

Required if accountPurpose includes "Other".

licensesOtherDescription

string

Required if licenses includes "Other".

primaryTargetMarketOtherDescription

string

Required if primaryTargetMarket is "Other".

highRiskIndustries

enum<string>[]

Required (min 1) if highRiskIndustryExposure is true.

Available options:

Money Services Businesses (MSBs),

Cryptocurrency and Digital Asset Exchanges,

Online Gambling and Gaming,

Adult Entertainment,

Cannabis and Marijuana,

Firearms and Weapons,

Pharmaceuticals and Controlled Substances,

Political Organizations and PACs,

Nonprofits and International Charities,

Shell Companies and Complex Holding Structures,

Precious Metals and Gems Dealers,

High-Value Real Estate,

Luxury Goods,

Private ATM Operators,

Pawn Shops,

Import and Export Trade Finance

highRiskActivityDescription

string

Required if highRiskIndustryExposure is true.

asiaExposureCountries

string[]

Required (min 1) if asiaExposure is true.

isUsMsb

boolean

Required if country is US.

usMsbCategories

enum<string>[]

Required (min 1) if isUsMsb is true.

Available options:

Money transmitter,

Currency dealer or exchanger,

Check casher,

Issuer of traveler's checks or money orders,

Provider of prepaid access,

Seller of prepaid access,

Dealer in foreign exchange,

Virtual currency / asset provider,

Other

usMsbCategoriesOtherDescription

string

Required if usMsbCategories includes "Other".

msbVirtualAssetSubtype

string

Required if usMsbCategories includes "Virtual currency / asset provider".

msbServiceDescription

string

Required if isUsMsb is true.

mxLegalEntityType

enum<string>

Required if country is MX.

Available options:

Personas Morales de nacionalidad mexicana,

Persona Moral de Nacionalidad Extranjera,

Persona Moral o Entidad referida en el Anexo 7-A de las Reglas de Carácter General

mxAnnex7ASubtype

string

Required if mxLegalEntityType is the Anexo 7-A option.

mxVulnerableActivityOrLicense

boolean

Required if country is MX.

mxVulnerableActivityDescription

string

Required if mxVulnerableActivityOrLicense is true.

mxExpectedMonthlyOperationCount

enum<string>

Required if country is MX.

Available options:

0 to 100,

101 to 200,

More than 201

mxEconomicActivity

string

Required if country is MX. See Appendix — 136-entry official "giro" catalog.

sourceOfFundsDocument

object

AiPrise's Source of Funds slot (also labeled "Estado financiero" for EUR-market businesses) — optional, every market.

Show child attributes

operatingLicenseDocument

object

Required if isUsMsb is true; optional otherwise.

Show child attributes

amlPolicy

object

Required if isUsMsb is true.

Show child attributes

beneficialControllerDeclaration

object

"Declaración Beneficiario Controlador Final" — optional, every market.

Show child attributes

Response

Business profile accepted for asynchronous processing — the AiPrise call chain runs in the background. Poll GET /details for progress.

success

boolean

Example:

true

data

object

Show child attributes

​Important Notes

​Use Cases

​Error Codes

​Common Errors

​User Ownership Errors

​Idempotency Errors

​Endpoint-Specific Errors

Authorizations

Headers

Body

Response

Important Notes

Use Cases

Error Codes

Common Errors

User Ownership Errors

Idempotency Errors

Endpoint-Specific Errors