US Insurance Card Extraction

Extracts card owner, ID number, sex, hospital effective date and medical effective date from a US insurance card.

POSThttps://sandbox/pcs/UsInsuranceCard

Content-Type: application/json

Headers

Header	Type	Required	Description
key	string	Yes	API key issued for authentication.

Request body

Field	Type	Required	Description
recordId	string	Yes	Unique ID you assign to correlate the request with the response.
image	string	Yes	Base64 string / data URI of the insurance card image.

Example

POST/pcs/UsInsuranceCard

curl --location 'https://sandbox/pcs/UsInsuranceCard' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "recordId": "1",
  "image": "data:image/png;base64,<BASE64_STRING>"
}'

200

{
"status": "TEXT NOT CLEAR",
"recordId": "1",
"data": {
  "Card_owner": "NAME-STRING",
  "ID_number": "W2N12345678M",
  "Sex": "MALE",
  "Hospital_effective_date": "01-01-2018",
  "Medical_effective_date": "01-01-2018"
},
"utc_time_stamp": "07/11/2024, 07:35:09"
}

Response

Field	Type	Description
status	string	SUCCESS, or a warning such as TEXT NOT CLEAR when parts of the card were hard to read.
recordId	string	Echoes the recordId sent in the request.
data.Card_owner	string	Name of the insured card owner.
data.ID_number	string	Member / policy ID number.
data.Sex	string	Card owner's sex.
data.Hospital_effective_date	string	Hospital coverage effective date.
data.Medical_effective_date	string	Medical coverage effective date.
utc_time_stamp	string	UTC timestamp of the response, DD/MM/YYYY, HH:mm:ss.

Error handling

200 on success, 422 on a validation error — see Error handling for the common error shape.