Skip to main content
POST
/
v1
/
document-verifications
Start Document Verification
curl --request POST \
  --url https://api.camber.so/v1/document-verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "type": "flu_vaccination",
    "url": "https://example.com/document.pdf",
    "external_id": "doc123",
    "metadata": {
      "key": "value"
    }
  },
  "person": {
    "first_name": "Tony",
    "last_name": "Stark",
    "middle_name": "J",
    "dob": "1970-05-29",
    "external_id": "person123",
    "metadata": {
      "key": "value"
    }
  },
  "external_id": "<string>",
  "metadata": {
    "reqId": "req123"
  },
  "rules": {},
  "sandbox": {
    "decision": "accepted",
    "status": "scheduled"
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "document_verification",
  "mode": "live",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "external_id": "verification123",
  "metadata": {
    "reqId": "req123"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

A document verification to start

​
document
object
required
​
person
object
required
​
external_id
string
​
metadata
object
Example:
{ "reqId": "req123" }
​
rules
object
​
sandbox
object

Response

202 - application/json

Successfully started document verification

​
id
string<uuid>
required
Example:

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

​
object
enum<string>
required
Available options:
document_verification,
license_verification,
list
​
mode
enum<string>
required
Available options:
live,
test
​
scheduled_at
string<date-time>
required
​
external_id
string | null
required
Example:

"verification123"

​
metadata
object
required
Example:
{ "reqId": "req123" }