Create a KYC Evaluation

POST /apply/kyc

Create a KYC Evaluation

cURL

curl --request POST \
  --url https://api.treasuryprime.com/apply/kyc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kyc_product_id": "akpt_1209bga8she7",
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  }
}
'

200

{
  "alloy": null,
  "alloy_full": null,
  "apply_true": null,
  "created_at": "2019-12-11T20:34:11Z",
  "id": "akyc_11f7av5311234",
  "kyc_product_id": "akpt_1209bga8she7",
  "middesk": null,
  "middesk_full": null,
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  },
  "updated_at": "2019-12-11T20:34:11Z"
}

Authorizations

basicAuthapiKey

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)

Show child attributes

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)

Show child attributes