Kita CaptureAPI reference

Applicants

Group related documents for one person or entity.

Assign a document to an applicant

PUT /documents/{document_id}/applicant

Send applicant_id: null to unassign.

PUT/documents/{document_id}/applicant

curl

curl -X PUT "https://api.kita.ai/api/v1/documents/42/applicant" \
  -H "Authorization: Bearer $KITA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "applicant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Path parameters

FieldTypeDescription
document_idrequiredintegerPositive integer document ID.

Request body · application/json

FieldTypeDescription
applicant_idrequiredstring | null

Response · 200

FieldTypeDescription
successboolean

Errors

FieldTypeDescription
404errorResource does not exist, or belongs to another organization.

List applicants

GET /applicants

Returns all applicants with their document counts.

GET/applicants

curl

curl -X GET "https://api.kita.ai/api/v1/applicants" \
  -H "Authorization: Bearer $KITA_API_KEY"

Response · 200

FieldTypeDescription
successboolean
applicantsobject[]
  applicants[].idstring(uuid)
  applicants[].namestring
  applicants[].emailstring(email)
  applicants[].phonestring
  applicants[].external_idstring
  applicants[].document_countinteger
  applicants[].created_atstring(date-time)

Errors

FieldTypeDescription
403errorNot permitted for this organization or plan.

Create an applicant

POST /applicants

POST/applicants

curl

curl -X POST "https://api.kita.ai/api/v1/applicants" \
  -H "Authorization: Bearer $KITA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Juan Dela Cruz",
  "email": "juan@example.com",
  "phone": "+639123456789",
  "external_id": "LOAN-2024-001"
}'

Request body · application/json

FieldTypeDescription
namerequiredstring
emailstring(email)
phonestring
external_idstringYour own reference ID.

Response · 201

FieldTypeDescription
idstring(uuid)
namestring
emailstring(email)
phonestring
external_idstring
document_countinteger
created_atstring(date-time)

Errors

FieldTypeDescription
400errorThe request was rejected. See `error` for the machine-readable code.

Cross-document analysis for an applicant

GET /applicants/{applicant_id}/cross-verification

Compares extracted fields across every document assigned to this applicant: name matching, income against deposits, employer verification and more.

GET/applicants/{applicant_id}/cross-verification

curl

curl -X GET "https://api.kita.ai/api/v1/applicants/{applicant_id}/cross-verification" \
  -H "Authorization: Bearer $KITA_API_KEY"

Path parameters

FieldTypeDescription
applicant_idrequiredstring(uuid)

200 Cross-verification report.

Errors

FieldTypeDescription
404errorResource does not exist, or belongs to another organization.

On this page