curl --request POST \
--url https://api.ropes.ai/api/public/id-checks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"email": "jsmith@example.com",
"expirationDays": 15,
"maxRetries": 1,
"startScoutIfNone": true,
"metadata": {}
}
'import requests
url = "https://api.ropes.ai/api/public/id-checks"
payload = {
"candidateId": "<string>",
"email": "jsmith@example.com",
"expirationDays": 15,
"maxRetries": 1,
"startScoutIfNone": True,
"metadata": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
email: 'jsmith@example.com',
expirationDays: 15,
maxRetries: 1,
startScoutIfNone: true,
metadata: {}
})
};
fetch('https://api.ropes.ai/api/public/id-checks', 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.ropes.ai/api/public/id-checks",
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([
'candidateId' => '<string>',
'email' => 'jsmith@example.com',
'expirationDays' => 15,
'maxRetries' => 1,
'startScoutIfNone' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.ropes.ai/api/public/id-checks"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.ropes.ai/api/public/id-checks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ropes.ai/api/public/id-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidateId": "<string>",
"status": "sent",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"attemptCount": 123,
"maxRetries": 123,
"attempts": [
{
"status": "in_progress",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"startedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z"
}
],
"continuity": {
"verdict": "match",
"referenceIsThisCheck": true
},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"id": "<string>",
"candidateId": "<string>",
"status": "sent",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"attemptCount": 123,
"maxRetries": 123,
"attempts": [
{
"status": "in_progress",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"startedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z"
}
],
"continuity": {
"verdict": "match",
"referenceIsThisCheck": true
},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}Create ID Check
Email a candidate a standalone ID check: a document and selfie verification with no assessment attached. Identify the candidate by candidateId or email. Each decided verification session uses one ID check credit, retries included. Send an optional Idempotency-Key header to retry safely: the same key and body replays the original check (200), a different body returns 409 IDEMPOTENCY_KEY_REUSED. Subscribe to the idCheck.sent, idCheck.completed and idCheck.expired webhooks to follow it. ID checks are enabled per organization; without them these endpoints return 404 NOT_FOUND. Responses never include names, dates of birth, document data or images.
Required scope: id_checks:write
curl --request POST \
--url https://api.ropes.ai/api/public/id-checks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"email": "jsmith@example.com",
"expirationDays": 15,
"maxRetries": 1,
"startScoutIfNone": true,
"metadata": {}
}
'import requests
url = "https://api.ropes.ai/api/public/id-checks"
payload = {
"candidateId": "<string>",
"email": "jsmith@example.com",
"expirationDays": 15,
"maxRetries": 1,
"startScoutIfNone": True,
"metadata": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
email: 'jsmith@example.com',
expirationDays: 15,
maxRetries: 1,
startScoutIfNone: true,
metadata: {}
})
};
fetch('https://api.ropes.ai/api/public/id-checks', 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.ropes.ai/api/public/id-checks",
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([
'candidateId' => '<string>',
'email' => 'jsmith@example.com',
'expirationDays' => 15,
'maxRetries' => 1,
'startScoutIfNone' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.ropes.ai/api/public/id-checks"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.ropes.ai/api/public/id-checks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ropes.ai/api/public/id-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"expirationDays\": 15,\n \"maxRetries\": 1,\n \"startScoutIfNone\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidateId": "<string>",
"status": "sent",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"attemptCount": 123,
"maxRetries": 123,
"attempts": [
{
"status": "in_progress",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"startedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z"
}
],
"continuity": {
"verdict": "match",
"referenceIsThisCheck": true
},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"id": "<string>",
"candidateId": "<string>",
"status": "sent",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"attemptCount": 123,
"maxRetries": 123,
"attempts": [
{
"status": "in_progress",
"failure": {
"code": "document_expired",
"reason": "<string>"
},
"startedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z"
}
],
"continuity": {
"verdict": "match",
"referenceIsThisCheck": true
},
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}{
"errorCode": "<string>",
"message": "<string>",
"idCheckId": "<string>"
}Authorizations
Each key carries scopes chosen when it is created: candidates:read, candidates:write, assessments:read, assessments:write, problems:read, problems:write, results:read, id_checks:read, id_checks:write. Keys created before scopes existed have full access. A request with a key that lacks an operation's scope returns 403 naming the missing scope.
Headers
Body
Response
Idempotent replay of an earlier request