Create Identity Verification Check
curl --request POST \
--url https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity_id": "<string>",
"redirect_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"labels": [
"<string>"
]
}
'import requests
url = "https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification"
payload = {
"identity_id": "<string>",
"redirect_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"labels": ["<string>"]
}
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({
identity_id: '<string>',
redirect_url: '<string>',
reason: 'ONBOARDING',
request_id: '<string>',
labels: ['<string>']
})
};
fetch('https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification', 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.prod.bastion.com/v2/identities/{identity_id}/id_verification",
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([
'identity_id' => '<string>',
'redirect_url' => '<string>',
'reason' => 'ONBOARDING',
'request_id' => '<string>',
'labels' => [
'<string>'
]
]),
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.prod.bastion.com/v2/identities/{identity_id}/id_verification"
payload := strings.NewReader("{\n \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\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.prod.bastion.com/v2/identities/{identity_id}/id_verification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification")
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 \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id_verification_check": {
"id": "<string>",
"identity_id": "<string>",
"verification_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"redirect_url": "<string>",
"status": "IN_PROGRESS",
"created_at": "2023-01-15T01:30:15.01Z",
"updated_at": "2023-01-15T01:30:15.01Z",
"labels": [
"<string>"
]
}
}Identity Verification
Create Identity Verification Check
Create an identity verification check for an individual identity.
POST
/
v2
/
identities
/
{identity_id}
/
id_verification
Create Identity Verification Check
curl --request POST \
--url https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity_id": "<string>",
"redirect_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"labels": [
"<string>"
]
}
'import requests
url = "https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification"
payload = {
"identity_id": "<string>",
"redirect_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"labels": ["<string>"]
}
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({
identity_id: '<string>',
redirect_url: '<string>',
reason: 'ONBOARDING',
request_id: '<string>',
labels: ['<string>']
})
};
fetch('https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification', 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.prod.bastion.com/v2/identities/{identity_id}/id_verification",
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([
'identity_id' => '<string>',
'redirect_url' => '<string>',
'reason' => 'ONBOARDING',
'request_id' => '<string>',
'labels' => [
'<string>'
]
]),
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.prod.bastion.com/v2/identities/{identity_id}/id_verification"
payload := strings.NewReader("{\n \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\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.prod.bastion.com/v2/identities/{identity_id}/id_verification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.bastion.com/v2/identities/{identity_id}/id_verification")
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 \"identity_id\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"reason\": \"ONBOARDING\",\n \"request_id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id_verification_check": {
"id": "<string>",
"identity_id": "<string>",
"verification_url": "<string>",
"reason": "ONBOARDING",
"request_id": "<string>",
"redirect_url": "<string>",
"status": "IN_PROGRESS",
"created_at": "2023-01-15T01:30:15.01Z",
"updated_at": "2023-01-15T01:30:15.01Z",
"labels": [
"<string>"
]
}
}Authorizations
Bearer authentication with an API token
Path Parameters
Unique identifier of the identity to verify
Body
application/json
Unique identifier of the identity to verify
(OPTIONAL) URL to redirect the user to after completing identity verification
Reason for the identity verification check
Available options:
IDV_CHECK_REASON_UNSPECIFIED, ONBOARDING, ACCOUNT_RECOVERY, RFI Example:
"ONBOARDING"
Client-provided idempotency key
(OPTIONAL) Labels to associate with this identity verification check
(OPTIONAL)
Response
Success
The created identity verification check
Show child attributes
Show child attributes
Related topics
Get Identity Verification CheckList Identity Verification ChecksRefresh Identity Verification Check URLIdentity verification API overviewOnboard an individual customer⌘I