Skip to main content
POST
/
v1
/
applicants
Create an applicant
curl --request POST \
  --url https://sandbox.apocor.ai/v1/applicants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "PERSON",
  "email": "[email protected]",
  "data": {
    "firstName": "Jane",
    "lastName": "Doe",
    "country": "US",
    "addressLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  }
}
'
import requests

url = "https://sandbox.apocor.ai/v1/applicants"

payload = {
    "type": "PERSON",
    "email": "[email protected]",
    "data": {
        "firstName": "Jane",
        "lastName": "Doe",
        "country": "US",
        "addressLine1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001"
    }
}
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({
    type: 'PERSON',
    email: '[email protected]',
    data: {
      firstName: 'Jane',
      lastName: 'Doe',
      country: 'US',
      addressLine1: '123 Main St',
      city: 'New York',
      state: 'NY',
      postalCode: '10001'
    }
  })
};

fetch('https://sandbox.apocor.ai/v1/applicants', 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",
  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([
    'type' => 'PERSON',
    'email' => '[email protected]',
    'data' => [
        'firstName' => 'Jane',
        'lastName' => 'Doe',
        'country' => 'US',
        'addressLine1' => '123 Main St',
        'city' => 'New York',
        'state' => 'NY',
        'postalCode' => '10001'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"type\": \"PERSON\",\n  \"email\": \"[email protected]\",\n  \"data\": {\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"country\": \"US\",\n    \"addressLine1\": \"123 Main St\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\"\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://sandbox.apocor.ai/v1/applicants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"PERSON\",\n  \"email\": \"[email protected]\",\n  \"data\": {\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"country\": \"US\",\n    \"addressLine1\": \"123 Main St\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.apocor.ai/v1/applicants")

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  \"type\": \"PERSON\",\n  \"email\": \"[email protected]\",\n  \"data\": {\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"country\": \"US\",\n    \"addressLine1\": \"123 Main St\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\"\n  }\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": "APPLICANT_ALREADY_EXISTS",
    "message": "Applicant already exists for this organization"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
default:PERSON
Available options:
PERSON,
BUSINESS
email
string<email>
data
object

Response

Applicant created.

data
object

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