Checks

List checks

Lists all checks available to the API client: the builtin catalog (identified by stable keys; prompts are never included) and the client's custom checks (identified by uuid; includes the authored prompt). Reference them from template check items.

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <api key>.

In: header

Query Parameters

limit?integer

Maximum number of items to return. Values above 100 are clamped to 100.

Range1 <= value <= 100

Default50

cursor?string

Opaque pagination cursor from the previous page's next_cursor.

Response Body

`application/json`

curl -X GET "https://example.com/v1/checks"

{  "data": [    {      "id": "string",      "key": "business_dd.company_legal_identification",      "builtin": true,      "title": "string",      "description": "string",      "prompt": "string",      "category": "additional_risk_notes",      "product_types": [        "personal_real_estate_financing"      ],      "archived": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

Create a custom check

Creates a custom check. The prompt is the partner-authored instruction the evaluation executes against the submission's documents; write it like a precise reviewer instruction with an explicit pass/fail criterion.

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <api key>.

In: header

Request Body

application/json

The check's attributes, including the authored prompt.

TypeScript Definitions

Use the request body type in TypeScript.

Attributes for a new custom check.

title*string

Human-readable title.

Length1 <= length <= 200

prompt*string

The instruction the evaluation executes. Write it like a precise reviewer instruction with an explicit pass/fail criterion; it runs against the submission's documents.

Length1 <= length <= 8000

description?|

What the check verifies.

Lengthlength <= 2000

category?CheckCategory

Topical category. Defaults to other.

Value in

"additional_risk_notes"
"analysis_packages"
"assets_property"
"bank_statements_additional"
"bank_statements_content"
"bank_statements_formal"
"bank_statements_period"
"business_identification"
"construction_documents"
"corporate_structure"
"financial_analysis"
"financing_exposure"
"general_plausibility"
"gf_detection"
"human_resources"
"income_cross_check"
"intellectual_property"
"land_register"
"minimum_documents"
"payslips_additional"
"payslips_age"
"payslips_content"
"payslips_formal"
"pension_assessment"
"pension_information"
"red_flags"
"regulatory_compliance"
"residence_permit"
"risk_assessment"
"self_declaration_schufa"
"sv_deduction_logic"
"transaction_structure"
"other"

product_types?array<>

Product families the check applies to. Defaults to all.

Response Body

`application/json`

curl -X POST "https://example.com/v1/checks" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "prompt": "string"  }'

{  "id": "string",  "key": "business_dd.company_legal_identification",  "builtin": true,  "title": "string",  "description": "string",  "prompt": "string",  "category": "additional_risk_notes",  "product_types": [    "personal_real_estate_financing"  ],  "archived": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

Get a check

Returns one check, builtin (never includes a prompt) or custom.

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <api key>.

In: header

Path Parameters

check_id*string

The check's id — a builtin check key or a custom uuid.

Response Body

`application/json`

curl -X GET "https://example.com/v1/checks/string"

{  "id": "string",  "key": "business_dd.company_legal_identification",  "builtin": true,  "title": "string",  "description": "string",  "prompt": "string",  "category": "additional_risk_notes",  "product_types": [    "personal_real_estate_financing"  ],  "archived": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

Update a custom check

Updates a custom check. The change is versioned internally: the id stays stable, templates referencing it use the new version for future submissions, and past evaluation results keep the version they ran with. Builtin checks cannot be updated (422 invalid_field).

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <api key>.

In: header

Path Parameters

check_id*string

The check's id — a builtin check key or a custom uuid.

Request Body

application/json

The attributes to change.

TypeScript Definitions

Use the request body type in TypeScript.

Custom check changes; omitted fields stay unchanged.

title?string

New title.

Length1 <= length <= 200

prompt?string

New instruction.

Length1 <= length <= 8000

description?|

New description, or null to clear it.

Lengthlength <= 2000

category?CheckCategory

New topical category.

Value in

"additional_risk_notes"
"analysis_packages"
"assets_property"
"bank_statements_additional"
"bank_statements_content"
"bank_statements_formal"
"bank_statements_period"
"business_identification"
"construction_documents"
"corporate_structure"
"financial_analysis"
"financing_exposure"
"general_plausibility"
"gf_detection"
"human_resources"
"income_cross_check"
"intellectual_property"
"land_register"
"minimum_documents"
"payslips_additional"
"payslips_age"
"payslips_content"
"payslips_formal"
"pension_assessment"
"pension_information"
"red_flags"
"regulatory_compliance"
"residence_permit"
"risk_assessment"
"self_declaration_schufa"
"sv_deduction_logic"
"transaction_structure"
"other"

product_types?array<>

New product family list.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/checks/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "key": "business_dd.company_legal_identification",  "builtin": true,  "title": "string",  "description": "string",  "prompt": "string",  "category": "additional_risk_notes",  "product_types": [    "personal_real_estate_financing"  ],  "archived": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

Archive a custom check

Archives a custom check: it disappears from listings and can no longer be added to templates. Templates and past results already referencing it keep working. Builtin checks cannot be archived (422 invalid_field).

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <api key>.

In: header

Path Parameters

check_id*string

The check's id — a builtin check key or a custom uuid.

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/checks/string"

Empty

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

200application/json

400application/json

401application/json

403application/json

429application/json

defaultapplication/json

201application/json

400application/json

401application/json

403application/json

422application/json

429application/json

defaultapplication/json

200application/json

401application/json

403application/json

404application/json

429application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

defaultapplication/json

204

401application/json

403application/json

404application/json

422application/json

429application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`