Update applicant profile
curl --request PATCH \
--url https://sandbox.apocor.ai/v1/applicants/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"ssn": "123456789"
}
}
'import requests
url = "https://sandbox.apocor.ai/v1/applicants/{id}"
payload = { "data": { "ssn": "123456789" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: {ssn: '123456789'}})
};
fetch('https://sandbox.apocor.ai/v1/applicants/{id}', 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://sandbox.apocor.ai/v1/applicants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'ssn' => '123456789'
]
]),
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://sandbox.apocor.ai/v1/applicants/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.apocor.ai/v1/applicants/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.apocor.ai/v1/applicants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"orgId": "<string>",
"type": "PERSON",
"status": "PENDING",
"email": "<string>",
"data": {},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Applicant must be approved"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Identity verification (KYC)
Update applicant profile
Merges allowlisted profile fields into the applicant. Contact fields (phone, etc.) can usually be updated. Identity fields (name, DOB, nationality, address) are locked after issuer KYC is complete or cards exist. ssn may be set once when missing (required for US card issuance after hosted KYC). Never changes status or issuer references.
PATCH
/
v1
/
applicants
/
{id}
Update applicant profile
curl --request PATCH \
--url https://sandbox.apocor.ai/v1/applicants/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"ssn": "123456789"
}
}
'import requests
url = "https://sandbox.apocor.ai/v1/applicants/{id}"
payload = { "data": { "ssn": "123456789" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: {ssn: '123456789'}})
};
fetch('https://sandbox.apocor.ai/v1/applicants/{id}', 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://sandbox.apocor.ai/v1/applicants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'ssn' => '123456789'
]
]),
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://sandbox.apocor.ai/v1/applicants/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.apocor.ai/v1/applicants/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.apocor.ai/v1/applicants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"ssn\": \"123456789\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"orgId": "<string>",
"type": "PERSON",
"status": "PENDING",
"email": "<string>",
"data": {},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Applicant must be approved"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Bearer access token obtained from POST /v1/oauth/token using your Apocor API key.
Path Parameters
Resource identifier.
Response
Updated applicant.
An end-user or business. Provider-internal identity references are white-labeled away.
Show child attributes
Show child attributes