Skip to main content
POST
Decide the client's latest KYB application, as the compliance reviewer would

Authorizations

Authorization
string
header
required

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

Headers

X-Hevn-Account
string | null

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

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

Body

application/json
status
enum<string>
required

The reviewer's decision: approved, rfi or rejected. approved needs a pending application, the other two a pending or approved one.

Available options:
pending,
approved,
rfi,
rejected,
superseded
comment
string | null

What the reviewer tells the client, returned as application.comment. Required for rfi and rejected.

Required string length: 1 - 2000

Response

Successful Response

ready
boolean
required

True when missing is empty and completion can be attempted.

missing
string[]

Outstanding fields and document slots as paths into the document, for example company.address.zip or people[0].documents.proof_of_address. A people index is the position in document.people of GET /dapi/v1/client/kyb.

status
enum<string>
default:notStarted

Review status of the latest application. It equals kybStatus on the client record.

Available options:
notStarted,
pending,
approved,
rfi,
rejected
application
PlatformKybApplicationResponse · object | null

Latest immutable submission under review.

document
PlatformKybDocumentBody · object

Current editable verification document projected from the entity graph.