HEhevn-inc
sandbox

Decide the client's latest KYB application, as the compliance reviewer would

Changed on

Moves the latest application to approved, rfi or rejected (the last two need a comment). Asking for the status it already has replays it. An rfi or rejected application is answered as in production: write the document and complete the submission again, then decide the new attempt.

post/sandbox/kyb/status

Request

Headers

X-Hevn-Accountstring nullable

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Request body

status'pending' | 'approved' | 'rfi' | 'rejected' | 'superseded' required
commentstring nullable

What the reviewer tells the client. Required for rfi and rejected.

Response

Successful Response

readyboolean required

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

missingstring[]

Outstanding applicant fields or document slots.

status'notStarted' | 'pending' | 'approved' | 'rfi' | 'rejected'

Example response

{
  "application": {
    "id": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
  },
  "document": {
    "company": {
      "expectedMonthlyVolumeUsd": "500.00",
      "expectedCryptoMonthlyVolumeUsd": "500.00",
      "expectedMonthlyAchUsd": "500.00",
      "expectedMonthlyWireUsd": "500.00",
      "estimatedAnnualRevenue": "500.00"
    },
    "people": [
      {
        "documents": [
          {
            "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
          }
        ]
      }
    ],
    "documents": [
      {
        "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
      }
    ]
  }
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the directors_registry enum value from the /// response property for the response status

    • info

      removed the directors_registry enum value from the ///// response property for the response status

    • info

      removed the list_of_authorized_signatories enum value from the /// response property for the response status

    • info

      removed the list_of_authorized_signatories enum value from the ///// response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • info

      endpoint added