Skip to main content
GET
/
v1
/
document-verifications
/
{id}
Get Document Verification
curl --request GET \
  --url https://api.camber.so/v1/document-verifications/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "document_verification",
  "status": "scheduled",
  "mode": "live",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_at": "2024-01-01T00:00:00Z",
  "completed_at": "2024-01-01T00:00:00Z",
  "failed_at": "2024-01-01T00:00:00Z",
  "external_id": "verification123",
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_type": "flu_vaccination",
  "metadata": {
    "reqId": "req123"
  },
  "decision": "accepted",
  "confidence": 90,
  "issues": [
    "issue1",
    "issue2"
  ],
  "data": {
    "key": "value"
  },
  "rules": {
    "key": "value"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Response

200 - application/json

Successfully retrieved document verification

​
id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
object
enum<string>
required
Available options:
document_verification,
license_verification,
list
​
status
enum<string>
required
Available options:
scheduled,
processing,
completed,
failed
​
mode
enum<string>
required
Available options:
live,
test
​
scheduled_at
string<date-time>
required
​
started_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

​
completed_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

​
failed_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

​
external_id
string | null
required
Example:

"verification123"

​
document_id
string<uuid>
required
​
document_type
enum<string>
required
Available options:
flu_vaccination,
resume,
tuberculosis_test,
covid_vaccination,
clipboard_health_badge,
physical_exam,
life_support_certification,
alcohol_handler_certification,
food_handler_certification
​
metadata
object
required
Example:
{ "reqId": "req123" }
​
decision
enum<string>
required
Available options:
accepted,
rejected,
flagged,
failed
Example:

"accepted"

​
confidence
number | null
required
Required range: 0 <= x <= 100
Example:

90

​
issues
string[] | null
required
Example:
["issue1", "issue2"]
​
data
object
required
Example:
{ "key": "value" }
​
rules
object
required
Example:
{ "key": "value" }