API ReferencePartner API

Evaluations

Start an evaluation

POST
/v1/submissions/{submission_id}/evaluations

Starts an automated evaluation over the submission's ready uploads. The evaluation runs asynchronously: the response returns it in status queued; follow progress via get_evaluation, get_submission (latest_evaluation), or the evaluation.* webhook events.

At most one evaluation is active per submission — starting while one is queued or running fails with 409 evaluation_in_progress. Starting a new evaluation after a completed or failed one re-evaluates the current set of uploads. The submission must have at least one upload in status ready (422 invalid_request otherwise) and must not be canceled.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

submission_id*string

The submission's AirCredit id (Submission.id).

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/submissions/497f6eca-6276-4993-bfeb-53cbbbba6f08/evaluations"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "basic",  "status": "queued",  "stage_label": "string",  "progress_percent": 0,  "input_file_ids": [    "e3aab2b7-8063-4c51-a985-2a562422618e"  ],  "failure": {    "code": "string",    "message": "string"  },  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "result": {    "documents": [      {        "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",        "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",        "external_file_id": "string",        "document_slot_id": "942421c5-3e28-44c2-9bb6-eb0d38b57f11",        "document_types": [          "string"        ],        "readability": {          "status": "passed"        }      }    ],    "fields": [      {        "data_field_id": "string",        "key": "anrede",        "label": "string",        "status": "succeeded",        "value": null,        "confidence": 0,        "citations": [          {            "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",            "external_file_id": "string",            "pages": [              1            ],            "excerpt": "string"          }        ]      }    ],    "checks": [      {        "check_id": "string",        "key": "business_dd.company_legal_identification",        "title": "string",        "status": "fulfilled",        "confidence": 0,        "citations": [          {            "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",            "external_file_id": "string",            "pages": [              1            ],            "excerpt": "string"          }        ],        "reasoning_summary": "string"      }    ],    "summary": {      "outcome": "outcome_uncertain",      "recommendation": "unknown",      "risk_band": "unknown"    }  },  "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",  "external_submission_id": "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"  }}
{  "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 an evaluation

GET
/v1/submissions/{submission_id}/evaluations/{evaluation_id}

Returns one evaluation of the submission, including the full result once the evaluation completed. Evaluation ids come from start_evaluation, SubmissionDetail.latest_evaluation.id, or evaluation.* events.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

submission_id*string

The submission's AirCredit id (Submission.id).

Formatuuid
evaluation_id*string

The evaluation's id (Evaluation.id).

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/submissions/497f6eca-6276-4993-bfeb-53cbbbba6f08/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "basic",  "status": "queued",  "stage_label": "string",  "progress_percent": 0,  "input_file_ids": [    "e3aab2b7-8063-4c51-a985-2a562422618e"  ],  "failure": {    "code": "string",    "message": "string"  },  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "result": {    "documents": [      {        "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",        "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",        "external_file_id": "string",        "document_slot_id": "942421c5-3e28-44c2-9bb6-eb0d38b57f11",        "document_types": [          "string"        ],        "readability": {          "status": "passed"        }      }    ],    "fields": [      {        "data_field_id": "string",        "key": "anrede",        "label": "string",        "status": "succeeded",        "value": null,        "confidence": 0,        "citations": [          {            "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",            "external_file_id": "string",            "pages": [              1            ],            "excerpt": "string"          }        ]      }    ],    "checks": [      {        "check_id": "string",        "key": "business_dd.company_legal_identification",        "title": "string",        "status": "fulfilled",        "confidence": 0,        "citations": [          {            "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",            "external_file_id": "string",            "pages": [              1            ],            "excerpt": "string"          }        ],        "reasoning_summary": "string"      }    ],    "summary": {      "outcome": "outcome_uncertain",      "recommendation": "unknown",      "risk_band": "unknown"    }  },  "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",  "external_submission_id": "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"  }}
{  "error": {    "code": "invalid_field",    "message": "external_submission_id must not be empty",    "param": "external_submission_id",    "request_id": "req_9b2cf1f4-6f6e-4a7e-8f8e-2d5c7a1b0c3d"  }}

Uploads

Previous page

Templates

Next page