Sign in
KYC

Fetch a KYC Evaluation

get/apply/kyc/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Response

The apply.kyc

alloyobject

Object containing a summary of the Alloy KYC evaluation (if enabled)

alloy_fullobject

Object containing the full response from Alloy (if enabled)

apply_typestring

Type of KYC waterfall. One of: personal, business. Filterable.

idstring

Unique identifier for object

kyc_product_idstring

ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.

middeskobject

Object containing a summary of the Middesk KYC evaluation (if enabled)

middesk_fullobject

Object containing the full response from Middesk (if enabled)

object_idstring

ID of the object (a person application or business application) for the KYC evaluation. Filterable.

object_typestring

One of: person, business. Filterable.

providerstring

Name of the KYC provider

provider_fullobject

Object containing the full KYC provider's response (if enabled)

Changes

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