Know your customer
Create a standard individual verification session
Creates a new KYC verification session for an individual. This endpoint initiates the identity verification process by collecting personal information and document details. The session will generate upload URLs for document images and can optionally require liveness verification.
x-api-key<token>
In: header
firstNamestring
lastNamestring
birthDatestring
documentCategorystring
Value in
"PASSPORT" | "DRIVERS_LICENSE" | "IDENTITY_CARD"documentCountrystring
Value in
"BRAZIL"documentIdstring
Match
^\d+$nationality?string
Value in
"AFGHAN" | "ALBANIAN" | "ALGERIAN" | "AMERICAN" | "ANDORRAN" | "ANGOLAN" | "ANTIGUANS" | "ARGENTINEAN" | "ARMENIAN" | "AUSTRALIAN" | "AUSTRIAN" | "AZERBAIJANI" | "BAHAMIAN" | "BAHRAINI" | "BANGLADESHI" | "BARBADIAN" | "BARBUDANS" | "BATSWANA" | "BELARUSIAN" | "BELGIAN" | "BELIZEAN" | "BENINESE" | "BHUTANESE" | "BOLIVIAN" | "BOSNIAN" | "BRAZILIAN" | "BRITISH" | "BRUNEIAN" | "BULGARIAN" | "BURKINABE" | "BURMESE" | "BURUNDIAN" | "CAMBODIAN" | "CAMEROONIAN" | "CANADIAN" | "CAPEVERDEAN" | "CENTRALAFRICAN" | "CHADIAN" | "CHILEAN" | "CHINESE" | "COLOMBIAN" | "COMORAN" | "CONGOLESE" | "COSTARICAN" | "CROATIAN" | "CUBAN" | "CYPRIOT" | "CZECH" | "DANISH" | "DJIBOUTI" | "DOMINICAN" | "DUTCH" | "EASTTIMORESE" | "ECUADOREAN" | "EGYPTIAN" | "EMIRIAN" | "EQUATORIALGUINEAN" | "ERITREAN" | "ESTONIAN" | "ETHIOPIAN" | "FIJIAN" | "FILIPINO" | "FINNISH" | "FRENCH" | "GABONESE" | "GAMBIAN" | "GEORGIAN" | "GERMAN" | "GHANAIAN" | "GREEK" | "GRENADIAN" | "GUATEMALAN" | "GUINEABISSAUAN" | "GUINEAN" | "GUYANESE" | "HAITIAN" | "HERZEGOVINIAN" | "HONDURAN" | "HUNGARIAN" | "KIRIBATI" | "ICELANDER" | "INDIAN" | "INDONESIAN" | "IRANIAN" | "IRAQI" | "IRISH" | "ISRAELI" | "ITALIAN" | "IVORIAN" | "JAMAICAN" | "JAPANESE" | "JORDANIAN" | "KAZAKHSTANI" | "KENYAN" | "KITTIAN" | "KUWAITI" | "KYRGYZ" | "LAOTIAN" | "LATVIAN" | "LEBANESE" | "LIBERIAN" | "LIBYAN" | "LIECHTENSTEINER" | "LITHUANIAN" | "LUXEMBOURGER" | "MACEDONIAN" | "MALAGASY" | "MALAWIAN" | "MALAYSIAN" | "MALDIVIAN" | "MALIAN" | "MALTESE" | "MARSHALLESE" | "MAURITANIAN" | "MAURITIAN" | "MEXICAN" | "MICRONESIAN" | "MOLDOVAN" | "MONACAN" | "MONGOLIAN" | "MOROCCAN" | "MOSOTHO" | "MOTSWANA" | "MOZAMBICAN" | "NAMIBIAN" | "NAURUAN" | "NEPALESE" | "NEWZEALANDER" | "NIVANUATU" | "NICARAGUAN" | "NIGERIAN" | "NIGERIEN" | "NORTHKOREAN" | "NORTHERNIRISH" | "NORWEGIAN" | "OMANI" | "PAKISTANI" | "PALAUAN" | "PANAMANIAN" | "PAPUANEWGUINEAN" | "PARAGUAYAN" | "PERUVIAN" | "POLISH" | "PORTUGUESE" | "QATARI" | "ROMANIAN" | "RUSSIAN" | "RWANDAN" | "SAINTLUCIAN" | "SALVADORAN" | "SAMOAN" | "SANMARINESE" | "SAOTOMEAN" | "SAUDI" | "SCOTTISH" | "SENEGALESE" | "SERBIAN" | "SEYCHELLOIS" | "SIERRALEONEAN" | "SINGAPOREAN" | "SLOVAKIAN" | "SLOVENIAN" | "SOLOMONISLANDER" | "SOMALI" | "SOUTHAFRICAN" | "SOUTHKOREAN" | "SPANISH" | "SRILANKAN" | "SUDANESE" | "SURINAMER" | "SWAZI" | "SWEDISH" | "SWISS" | "SYRIAN" | "TAIWANESE" | "TAJIK" | "TANZANIAN" | "THAI" | "TOGOLESE" | "TONGAN" | "TRINIDADIAN" | "TUNISIAN" | "TURKISH" | "TUVALUAN" | "UGANDAN" | "UKRAINIAN" | "URUGUAYAN" | "UZBEKISTANI" | "VENEZUELAN" | "VIETNAMESE" | "WELSH" | "YEMENITE" | "ZAMBIAN" | "ZIMBABWEAN"livenessRequiredboolean
Response Body
curl -X POST "https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard" \
-H "Content-Type: application/json" \
-d '{
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
}'const body = JSON.stringify({
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
})
fetch("https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard", {
body
})package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard"
body := strings.NewReader(`{
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import requests
url = "https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard"
body = {
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
}
response = requests.request("POST", url, json = body, headers = {
"Content-Type": "application/json"
})
print(response.text)import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;
var body = BodyPublishers.ofString("""{
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
}""");
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard"))
.header("Content-Type", "application/json")
.POST(body)
.build();
try {
HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
System.out.println("Status code: " + response.statusCode());
System.out.println("Response body: " + response.body());
} catch (Exception e) {
e.printStackTrace();
}using System;
using System.Net.Http;
using System.Text;
var body = new StringContent("""
{
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true
}
""", Encoding.UTF8, "application/json");
var client = new HttpClient();
var response = await client.PostAsync("https://api.notus.team/api/v1/kyc/individual-verification-sessions/standard", body);
var responseBody = await response.Content.ReadAsStringAsync();{
"session": {
"id": "string",
"status": "PENDING",
"livenessRequired": true,
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"document": {
"id": "string",
"type": "string",
"category": "string"
},
"createdAt": "string",
"updatedAt": "string"
},
"backDocument": {
"url": "string",
"fields": {
"bucket": "string",
"X-Amz-Algorithm": "string",
"X-Amz-Credential": "string",
"X-Amz-Date": "string",
"key": "string",
"Policy": "string",
"X-Amz-Signature": "string"
}
},
"frontDocument": {
"url": "string",
"fields": {
"bucket": "string",
"X-Amz-Algorithm": "string",
"X-Amz-Credential": "string",
"X-Amz-Date": "string",
"key": "string",
"Policy": "string",
"X-Amz-Signature": "string"
}
}
}Create a fiat withdrawal quote POST
This endpoint creates a fiat withdrawal quote.
Get a standard individual verification session result GET
Retrieves the current status and results of a standard individual verification session. This endpoint allows you to check the progress and outcome of a KYC verification process.