Skip to main content
POST
/
v1
/
applicants
/
{id}
/
kyc-share
Share BYOK verification with the issuer
curl --request POST \
  --url https://sandbox.apocor.ai/v1/applicants/{id}/kyc-share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sumsub_share_token": "eyJ...",
  "kyc_vendor_ref": "63f1...",
  "status": "APPROVED"
}
'
import requests

url = "https://sandbox.apocor.ai/v1/applicants/{id}/kyc-share"

payload = {
    "sumsub_share_token": "eyJ...",
    "kyc_vendor_ref": "63f1...",
    "status": "APPROVED"
}
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({sumsub_share_token: 'eyJ...', kyc_vendor_ref: '63f1...', status: 'APPROVED'})
};

fetch('https://sandbox.apocor.ai/v1/applicants/{id}/kyc-share', 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}/kyc-share",
  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([
    'sumsub_share_token' => 'eyJ...',
    'kyc_vendor_ref' => '63f1...',
    'status' => 'APPROVED'
  ]),
  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}/kyc-share"

	payload := strings.NewReader("{\n  \"sumsub_share_token\": \"eyJ...\",\n  \"kyc_vendor_ref\": \"63f1...\",\n  \"status\": \"APPROVED\"\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://sandbox.apocor.ai/v1/applicants/{id}/kyc-share")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sumsub_share_token\": \"eyJ...\",\n  \"kyc_vendor_ref\": \"63f1...\",\n  \"status\": \"APPROVED\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.apocor.ai/v1/applicants/{id}/kyc-share")

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  \"sumsub_share_token\": \"eyJ...\",\n  \"kyc_vendor_ref\": \"63f1...\",\n  \"status\": \"APPROVED\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "orgId": "<string>",
    "email": "<string>",
    "data": {},
    "issuerKycReady": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Applicant must be approved"
  }
}

Authorizations

Authorization
string
header
required

Bearer access token obtained from POST /v1/oauth/token using your Apocor API key.

Path Parameters

id
string
required

Resource identifier.

Body

application/json
sumsub_share_token
string
required

Short-lived identity share token from your provider

kyc_vendor_ref
string

Your identity provider applicant id (optional)

status
enum<string>

Attest tenant-side KYC approval

Available options:
APPROVED

Response

Updated applicant with issuer KYC status.

data
object

An end-user or business. Provider-internal identity references are white-labeled away.