Skip to main content
POST
Submit a verification questionnaire

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Body

application/json
type
enum<string>
required

Which questionnaire these answers are for. New values may be added. If this names a questionnaire that does not exist, the request is rejected and the error tells you which names are valid.

Available options:
occupation
Example:

"occupation"

jobTitle
string
required

The customer's occupation, free text. Up to 255 characters.

Example:

"Software Engineer"

industry
string
required

Occupation category: a code from GET /verification/occupations. The label is not accepted; it is display copy and can be reworded.

Example:

"4430200"

Response

Accepted and being applied. The customer's current verification status is returned.

Where the customer's verification stands after a write. status is the same value GET /organization/{organizationId}/kyc reports.

organizationId
string<uuid>
required
status
enum<string>
required
  • notStarted: verification has not started.
  • inProgress: the customer started but has not submitted everything.
  • submitted: submitted and waiting for review.
  • approved: cleared.
  • denied: rejected, or a previous approval was revoked.
Available options:
notStarted,
inProgress,
submitted,
approved,
denied