Link two entities in the KYB graph

Create one ownership edge pointing from the owner to the owned entity.

POST /api/v1/kyb/b2b/kyb/relationships

Link two entities in the KYB graph

cURL

curl --request POST \
  --url https://api.example.com/api/v1/kyb/b2b/kyb/relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

201

{
  "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

Create or partially update a relationship in the KYB graph.

sourceEntityId · string<uuid> · required

targetEntityId · string<uuid> · required

ownershipPercentage · number string

Required range: 0 < x <= 100

id · string<uuid> | null

hasControl · boolean | null

isDirector · boolean | null

isSigner · boolean | null

title · string | null

Office held in the target company, for example 'Director'.

Maximum string length: 255

Response

201

application/json

Successful Response

id · string<uuid> · required

sourceEntityId · string<uuid> · required

targetEntityId · string<uuid> · required

hasControl · boolean · required

isDirector · boolean · required

isSigner · boolean · required

ownershipPercentage · string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

title · string | null

status · enum<string> · default: active

Consent state for a KYB ownership or authority relationship.

Available options: pending, active, revoked

verifications · EntityProviderVerificationData · object[]

Show child attributes