Create a KYC Evaluation

curl --request POST \
  --url https://api.treasuryprime.com/apply/kyc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kyc_product_id": "akpt_1209bga8she7",
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  }
}
'

import requests

url = "https://api.treasuryprime.com/apply/kyc"

payload = {
    "kyc_product_id": "akpt_1209bga8she7",
    "object_id": "apsn_01d5w6yaa6vu",
    "object_type": "person",
    "provider": "<provider>",
    "provider_full": {},
    "provider_result": { "outcome": "ok" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kyc_product_id: 'akpt_1209bga8she7',
    object_id: 'apsn_01d5w6yaa6vu',
    object_type: 'person',
    provider: '<provider>',
    provider_full: {},
    provider_result: {outcome: 'ok'}
  })
};

fetch('https://api.treasuryprime.com/apply/kyc', 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.treasuryprime.com/apply/kyc",
  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([
    'kyc_product_id' => 'akpt_1209bga8she7',
    'object_id' => 'apsn_01d5w6yaa6vu',
    'object_type' => 'person',
    'provider' => '<provider>',
    'provider_full' => [
        
    ],
    'provider_result' => [
        'outcome' => 'ok'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.treasuryprime.com/apply/kyc"

	payload := strings.NewReader("{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.treasuryprime.com/apply/kyc")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/apply/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "alloy": null,
  "alloy_full": null,
  "apply_true": null,
  "created_at": "2019-12-11T20:34:11Z",
  "id": "akyc_11f7av5311234",
  "kyc_product_id": "akpt_1209bga8she7",
  "middesk": null,
  "middesk_full": null,
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  },
  "updated_at": "2019-12-11T20:34:11Z"
}

POST

apply

kyc

Create a KYC Evaluation

curl --request POST \
  --url https://api.treasuryprime.com/apply/kyc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kyc_product_id": "akpt_1209bga8she7",
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  }
}
'

import requests

url = "https://api.treasuryprime.com/apply/kyc"

payload = {
    "kyc_product_id": "akpt_1209bga8she7",
    "object_id": "apsn_01d5w6yaa6vu",
    "object_type": "person",
    "provider": "<provider>",
    "provider_full": {},
    "provider_result": { "outcome": "ok" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kyc_product_id: 'akpt_1209bga8she7',
    object_id: 'apsn_01d5w6yaa6vu',
    object_type: 'person',
    provider: '<provider>',
    provider_full: {},
    provider_result: {outcome: 'ok'}
  })
};

fetch('https://api.treasuryprime.com/apply/kyc', 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.treasuryprime.com/apply/kyc",
  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([
    'kyc_product_id' => 'akpt_1209bga8she7',
    'object_id' => 'apsn_01d5w6yaa6vu',
    'object_type' => 'person',
    'provider' => '<provider>',
    'provider_full' => [
        
    ],
    'provider_result' => [
        'outcome' => 'ok'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.treasuryprime.com/apply/kyc"

	payload := strings.NewReader("{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.treasuryprime.com/apply/kyc")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/apply/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kyc_product_id\": \"akpt_1209bga8she7\",\n  \"object_id\": \"apsn_01d5w6yaa6vu\",\n  \"object_type\": \"person\",\n  \"provider\": \"<provider>\",\n  \"provider_full\": {},\n  \"provider_result\": {\n    \"outcome\": \"ok\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "alloy": null,
  "alloy_full": null,
  "apply_true": null,
  "created_at": "2019-12-11T20:34:11Z",
  "id": "akyc_11f7av5311234",
  "kyc_product_id": "akpt_1209bga8she7",
  "middesk": null,
  "middesk_full": null,
  "object_id": "apsn_01d5w6yaa6vu",
  "object_type": "person",
  "provider": "<provider>",
  "provider_full": {},
  "provider_result": {
    "outcome": "ok"
  },
  "updated_at": "2019-12-11T20:34:11Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The apply.kyc to create

object_id

string

required

ID of the object (a person application or business application) for the KYC evaluation. Filterable.

object_type

string

required

One of: person, business. Filterable.

kyc_product_id

string

ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.

provider

string

Name of the KYC provider

provider_full

object

Object containing the full KYC provider's response (if enabled)

provider_result

object

Object containing a summary of the KYC provider's evaluation (if enabled)

Show child attributes

Response

200 - application/json

The apply.kyc created

alloy

object

Object containing a summary of the Alloy KYC evaluation (if enabled)

alloy_full

object

Object containing the full response from Alloy (if enabled)

apply_type

string

Type of KYC waterfall. One of: personal, business. Filterable.

string

Unique identifier for object

kyc_product_id

string

middesk

object

deprecated

Object containing a summary of the Middesk KYC evaluation (if enabled)

middesk_full

object

Object containing the full response from Middesk (if enabled)

object_id

string

ID of the object (a person application or business application) for the KYC evaluation. Filterable.

object_type

string

One of: person, business. Filterable.

provider

string

Name of the KYC provider

provider_full

object

Object containing the full KYC provider's response (if enabled)

provider_result

object

Object containing a summary of the KYC provider's evaluation (if enabled)

Show child attributes

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Body

Response