Add an owner and its ownership edge in one request

POST /api/v1/kyb/b2b/kyb/owners

Add an owner and its ownership edge in one request

cURL

curl --request POST \
  --url https://api.example.com/api/v1/kyb/b2b/kyb/owners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "dateOfBirth": "2023-12-25",
    "nationalities": [],
    "title": "<string>",
    "legalName": "<string>",
    "tradeName": "<string>",
    "registrationNumber": "<string>",
    "taxId": "<string>",
    "address": {
      "streetAddress": "<string>",
      "city": "<string>",
      "addressLine2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "documents": {},
    "identityDocuments": [
      {
        "number": "<string>"
      }
    ],
    "companyDdData": {
      "entityType": "<string>",
      "entityTypeDescription": "<string>",
      "incorporationDate": "2023-12-25",
      "industry": "<string>",
      "websites": [
        "<string>"
      ],
      "operatingCountries": [],
      "expectedMonthlyVolumeUsd": 1,
      "estimatedAnnualRevenue": 1,
      "hasUsBank": true,
      "deniedUsBank": true,
      "hasPep": true,
      "bizAdverse": [
        "<string>"
      ],
      "ownersAdverse": [
        "<string>"
      ],
      "publicListed": true,
      "usesBlockchain": true,
      "institutionalInvestors": true,
      "isRegulated": true
    },
    "usageData": {
      "business": "<string>",
      "businessIndustry": "<string>",
      "businessType": "<string>",
      "businessTypeDetails": "<string>",
      "verifierRole": "<string>",
      "sourceOfFunds": "<string>",
      "sourceOfFundsDetails": "<string>",
      "purposeOfFunds": "<string>",
      "purposeOfFundsDetails": "<string>",
      "flowOfFunds": "<string>",
      "complianceScreening": "<string>",
      "handlesCustomerFunds": true,
      "actingAsIntermediary": true,
      "sanctionedCountryOperations": true,
      "highRiskActivities": [
        "<string>"
      ],
      "depositMethods": [
        "<string>"
      ],
      "contactInfo": "<string>"
    },
    "acceptedTermsAt": "2023-11-07T05:31:56Z"
  }
}
'

201

{
  "entity": {
    "creatorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "corporateAuthorityDocumentIds": {
      "authorizationToActDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "authorityToBindDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceId": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "country": "AF",
    "dateOfBirth": "2023-12-25",
    "birthCountry": "AF",
    "nationalities": [
      "AF"
    ],
    "title": "<string>",
    "legalName": "<string>",
    "tradeName": "<string>",
    "registrationNumber": "<string>",
    "taxId": "<string>",
    "address": {
      "streetAddress": "<string>",
      "city": "<string>",
      "country": "AF",
      "addressLine2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "documents": {},
    "identityDocuments": [
      {
        "type": "passport",
        "issuingCountry": "AF",
        "number": "<string>"
      }
    ],
    "companyDdData": {
      "entityType": "<string>",
      "entityTypeDescription": "<string>",
      "incorporationDate": "2023-12-25",
      "industry": "<string>",
      "websites": [
        "<string>"
      ],
      "operatingCountries": [
        "AF"
      ],
      "expectedMonthlyVolumeUsd": "<string>",
      "estimatedAnnualRevenue": "<string>",
      "hasUsBank": true,
      "deniedUsBank": true,
      "hasPep": true,
      "bizAdverse": [
        "<string>"
      ],
      "ownersAdverse": [
        "<string>"
      ],
      "publicListed": true,
      "txPerMonth": "<10",
      "usesBlockchain": true,
      "revenueCovers": "all_operating_expenses",
      "institutionalInvestors": true,
      "isRegulated": true
    },
    "usageData": {
      "business": "<string>",
      "businessIndustry": "<string>",
      "businessType": "<string>",
      "businessTypeDetails": "<string>",
      "verifierRole": "<string>",
      "sourceOfFunds": "<string>",
      "sourceOfFundsDetails": "<string>",
      "purposeOfFunds": "<string>",
      "purposeOfFundsDetails": "<string>",
      "flowOfFunds": "<string>",
      "complianceScreening": "<string>",
      "handlesCustomerFunds": true,
      "actingAsIntermediary": true,
      "sanctionedCountryOperations": true,
      "highRiskActivities": [
        "<string>"
      ],
      "depositMethods": [
        "<string>"
      ],
      "contactInfo": "<string>"
    },
    "acceptedTermsAt": "2023-11-07T05:31:56Z"
  },
  "relationship": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targetEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "hasControl": true,
    "isDirector": true,
    "isSigner": true,
    "ownershipPercentage": "<string>",
    "title": "<string>",
    "status": "active",
    "verifications": [
      {
        "provider": "swipelux",
        "status": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalId": "<string>",
        "kycLink": "<string>",
        "kycLinkState": "<string>",
        "kycLinkExpiresAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

Add an owner: the person (or holding company) AND the edge that makes them one.

Two requests could not express this. An entity saved without its edge is unreachable from the ownership walk, so nothing could ever show it again — which is how editors accumulated people nobody could see.

entity · EntityDraftWrite · object · required

Create or partially update an entity from the KYB draft editor.

Show child attributes

ownershipPercentage · number string

Required range: 0 < x <= 100

targetEntityId · string<uuid> | null

hasControl · boolean · default: false

isDirector · boolean · default: false

isSigner · boolean · default: false

Response

201

application/json

Successful Response

Both halves of the owner that was just created, with their ids.

entity · EntityData · object · required

Show child attributes

relationship · EntityRelationshipDraftData · object · required

Show child attributes