Retrieve the verification submission

Return the current editable applicant information, related people, filed documents, outstanding requirements and the latest review status. missing is authoritative for whether complete can succeed. A pending or completed review is read-only as an application snapshot; later draft edits apply to the next submission.

GET /client/kyb

Retrieve the verification submission

cURL

curl --request GET \
  --url https://api.example.com/client/kyb \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Hevn-Account: <x-hevn-account>'

200

{
  "ready": true,
  "missing": [
    "<string>"
  ],
  "status": "notStarted",
  "application": {
    "id": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
    "attemptNo": 123,
    "status": "notStarted",
    "submittedAt": "2023-11-07T05:31:56Z",
    "comment": "<string>",
    "decidedAt": "2023-11-07T05:31:56Z"
  },
  "document": {
    "company": {
      "legalName": "<string>",
      "tradeName": "<string>",
      "country": "<string>",
      "registrationNumber": "<string>",
      "linkedinUrl": "<string>",
      "taxId": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "address": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>"
      },
      "entityType": "<string>",
      "entityTypeDescription": "<string>",
      "incorporationDate": "2023-12-25",
      "industry": "<string>",
      "websites": [
        "<string>"
      ],
      "operatingCountries": [
        "<string>"
      ],
      "expectedMonthlyVolumeUsd": "500.00",
      "expectedCryptoMonthlyVolumeUsd": "500.00",
      "expectedMonthlyAchUsd": "500.00",
      "expectedMonthlyWireUsd": "500.00",
      "cryptoIndustrySubtype": "<string>",
      "hasIntermediateEntityOwnership": true,
      "primaryTargetMarket": "<string>",
      "estimatedAnnualRevenue": "500.00",
      "hasUsBank": true,
      "deniedUsBank": true,
      "hasPep": true,
      "bizAdverse": [
        "<string>"
      ],
      "ownersAdverse": [
        "<string>"
      ],
      "publicListed": true,
      "txPerMonth": "<string>",
      "usesBlockchain": true,
      "revenueCovers": "<string>",
      "institutionalInvestors": true,
      "isRegulated": true,
      "productsServices": [
        "<string>"
      ],
      "businessDescription": "<string>",
      "businessType": "<string>",
      "businessTypeDetails": "<string>",
      "businessIndustry": "<string>",
      "verifierRole": "<string>",
      "sourceOfFunds": "<string>",
      "sourceOfFundsDetails": "<string>",
      "purposeOfFunds": "<string>",
      "purposeOfFundsDetails": "<string>",
      "flowOfFunds": "<string>",
      "complianceScreening": "<string>",
      "moneyServicesDescription": "<string>",
      "handlesCustomerFunds": true,
      "actingAsIntermediary": true,
      "sanctionedCountryOperations": true,
      "highRiskActivities": [
        "<string>"
      ],
      "depositMethods": [
        "<string>"
      ],
      "contactInfo": "<string>",
      "identityDocuments": [
        {
          "type": "passport",
          "issuingCountry": "<string>",
          "number": "<string>"
        }
      ]
    },
    "people": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "dateOfBirth": "2023-12-25",
        "birthCountry": "<string>",
        "nationalities": [
          "<string>"
        ],
        "title": "<string>",
        "country": "<string>",
        "linkedinUrl": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "address": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "<string>"
        },
        "taxIdCountry": "<string>",
        "taxId": "<string>",
        "identityDocuments": [
          {
            "type": "passport",
            "issuingCountry": "<string>",
            "number": "<string>"
          }
        ],
        "ownershipPercentage": "<string>",
        "hasControl": false,
        "isDirector": false,
        "isSigner": false,
        "documents": [
          {
            "slot": "certificate_of_incorporation",
            "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
          }
        ]
      }
    ],
    "documents": [
      {
        "slot": "certificate_of_incorporation",
        "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Headers

X-Hevn-Account · string · required

The selected client account, as a cl_… id.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Response

200

application/json

Successful Response

ready · boolean · required

Whether all known requirements are satisfied and completion can be attempted.

missing · string[]

Outstanding applicant fields or document slots.

status · enum<string> · default: notStarted

Current public review status.

Available options: notStarted, pending, approved, rfi, rejected

application · PlatformKybApplicationResponse · object | null

Latest immutable submission under review.

Show child attributes

document · PlatformKybDocumentBody · object

Current editable verification document projected from the entity graph.

Show child attributes