Company

Check KYC prerequisites

Evaluates whether the company meets the prerequisites required before its KYC can be sent to review. Returns all_passed and, when it is false, the list of missing issues (each serialized as a hash describing the failing prerequisite).

get/v1/companies/{id}/kyc_prerequisites

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

#/paths/~1v1~1users/get/parameters/0 — unresolved $ref

Response

KYC prerequisite evaluation.

all_passedboolean
missingobject[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.