Identity Checks#

An Identity Check represents an individual identity verification result within a Verification Report. Each check validates a specific aspect of the applicant's identity.

The Identity Check object#

Attribute	Type	Description
`id`	string	Unique identifier with `idc_` prefix
`object`	string	Always `"identity_check"`
`session`	string	Associated Verification Session ID
`check_type`	enum	`document_verification`, `selfie_match`, `address_verification`, `watchlist_screening`
`status`	enum	`pending`, `passed`, `failed`, `inconclusive`
`result`	object	Check-specific results
`created`	timestamp	Time at which the check was created

{
  "id": "idc_abc123",
  "object": "identity_check",
  "session": "vs_1a2b3c4d5e6f",
  "check_type": "document_verification",
  "status": "passed",
  "result": {
    "document_type": "passport",
    "document_country": "GB",
    "first_name": "Jane",
    "last_name": "Doe",
    "date_of_birth": "1990-05-15",
    "expiry_date": "2030-03-15",
    "authenticity_score": 0.99,
    "tamper_detection": "clear"
  },
  "created": 1706140800
}

Retrieve an Identity Check#

GET /v1/identity_checks/:id

curl https://api.casapay.com/v1/identity_checks/idc_abc123 \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

List Identity Checks#

GET /v1/identity_checks

Parameter	Type	Description
`session`	string	Filter by Verification Session ID
`check_type`	string	Filter by check type
`status`	string	Filter by status

curl https://api.casapay.com/v1/identity_checks?session=vs_1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"