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": {
"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": {}
}
'import requests
url = "https://api.camber.so/v1/document-verifications"
payload = {
"document": {
"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": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {
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: {}
})
};
fetch('https://api.camber.so/v1/document-verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.camber.so/v1/document-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.camber.so/v1/document-verifications"
payload := strings.NewReader("{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.camber.so/v1/document-verifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.camber.so/v1/document-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"scheduled_at": "2023-11-07T05:31:56Z",
"external_id": "verification123",
"metadata": {
"reqId": "req123"
}
}Document Verification
Start Document Verification
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": {
"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": {}
}
'import requests
url = "https://api.camber.so/v1/document-verifications"
payload = {
"document": {
"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": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {
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: {}
})
};
fetch('https://api.camber.so/v1/document-verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.camber.so/v1/document-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.camber.so/v1/document-verifications"
payload := strings.NewReader("{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.camber.so/v1/document-verifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.camber.so/v1/document-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"url\": \"https://example.com/document.pdf\",\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"person\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"middle_name\": \"J\",\n \"dob\": \"1970-05-29\",\n \"external_id\": \"person123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"external_id\": \"<string>\",\n \"metadata\": {\n \"reqId\": \"req123\"\n },\n \"rules\": {},\n \"sandbox\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"scheduled_at": "2023-11-07T05:31:56Z",
"external_id": "verification123",
"metadata": {
"reqId": "req123"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A document verification to start
Response
202 - application/json
Successfully started document verification
Example:
"123e4567-e89b-12d3-a456-426614174000"
Available options:
document_verification, license_verification, list Available options:
live, test Example:
"verification123"
Show child attributes
Show child attributes
Example:
{ "reqId": "req123" }
⌘I
