Skip to main content
POST
Create a KYC Evaluation

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The apply.kyc to create

object_id
string
required

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

object_type
string
required

One of: person, business. Filterable.

kyc_product_id
string

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.

provider
string

Name of the KYC provider

provider_full
object

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

provider_result
object

Object containing a summary of the KYC provider's evaluation (if enabled)

Response

200 - application/json

The apply.kyc created

alloy
object

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

alloy_full
object

Object containing the full response from Alloy (if enabled)

apply_type
string

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

id
string

Unique identifier for object

kyc_product_id
string

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.

middesk
object
deprecated

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

middesk_full
object

Object containing the full response from Middesk (if enabled)

object_id
string

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

object_type
string

One of: person, business. Filterable.

provider
string

Name of the KYC provider

provider_full
object

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

provider_result
object

Object containing a summary of the KYC provider's evaluation (if enabled)