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" | "AFGHANISTAN" | "ALBANIA" | "ALGERIA" | "AMERICAN_SAMOA" | "ANDORRA" | "ANGOLA" | "ANGUILLA" | "ANTARCTICA" | "ANTIGUA_AND_BARBUDA" | "ARGENTINA" | "ARMENIA" | "ARUBA" | "AUSTRALIA" | "AUSTRIA" | "AZERBAIJAN" | "BAHAMAS" | "BAHRAIN" | "BANGLADESH" | "BARBADOS" | "BELARUS" | "BELGIUM" | "BELIZE" | "BENIN" | "BERMUDA" | "BHUTAN" | "BOLIVIA" | "BONAIRE_SINT_EUSTATIUS_AND_SABA" | "BOSNIA_AND_HERZEGOVINA" | "BOTSWANA" | "BOUVET_ISLAND" | "BRITISH_INDIAN_OCEAN_TERRITORY" | "BRUNEI_DARUSSALAM" | "BULGARIA" | "BURKINA_FASO" | "BURUNDI" | "CABO_VERDE" | "CAMBODIA" | "CAMEROON" | "CANADA" | "CAYMAN_ISLANDS" | "CENTRAL_AFRICAN_REPUBLIC" | "CHAD" | "CHILE" | "CHINA" | "CHRISTMAS_ISLAND" | "COCOS_KEELING_ISLANDS" | "COLOMBIA" | "COMOROS" | "CONGO_DEMOCRATIC_REPUBLIC" | "CONGO_REPUBLIC" | "COOK_ISLANDS" | "COSTA_RICA" | "CROATIA" | "CUBA" | "CURACAO" | "CYPRUS" | "CZECH_REPUBLIC" | "COTE_DIVOIRE" | "DENMARK" | "DJIBOUTI" | "DOMINICA" | "DOMINICAN_REPUBLIC" | "ECUADOR" | "EGYPT" | "EL_SALVADOR" | "EQUATORIAL_GUINEA" | "ERITREA" | "ESTONIA" | "ESWATINI" | "ETHIOPIA" | "FALKLAND_ISLANDS" | "FAROE_ISLANDS" | "FIJI" | "FINLAND" | "FRANCE" | "FRENCH_GUIANA" | "FRENCH_POLYNESIA" | "FRENCH_SOUTHERN_TERRITORIES" | "GABON" | "GAMBIA" | "GEORGIA" | "GERMANY" | "GHANA" | "GIBRALTAR" | "GREECE" | "GREENLAND" | "GRENADA" | "GUADELOUPE" | "GUAM" | "GUATEMALA" | "GUERNSEY" | "GUINEA" | "GUINEA_BISSAU" | "GUYANA" | "HAITI" | "HEARD_ISLAND_AND_MCDONALD_ISLANDS" | "HOLY_SEE" | "HONDURAS" | "HONG_KONG" | "HUNGARY" | "ICELAND" | "INDIA" | "INDONESIA" | "IRAN" | "IRAQ" | "IRELAND" | "ISLE_OF_MAN" | "ISRAEL" | "ITALY" | "JAMAICA" | "JAPAN" | "JERSEY" | "JORDAN" | "KAZAKHSTAN" | "KENYA" | "KIRIBATI" | "NORTH_KOREA" | "SOUTH_KOREA" | "KUWAIT" | "KYRGYZSTAN" | "LAOS" | "LATVIA" | "LEBANON" | "LESOTHO" | "LIBERIA" | "LIBYA" | "LIECHTENSTEIN" | "LITHUANIA" | "LUXEMBOURG" | "MACAO" | "MADAGASCAR" | "MALAWI" | "MALAYSIA" | "MALDIVES" | "MALI" | "MALTA" | "MARSHALL_ISLANDS" | "MARTINIQUE" | "MAURITANIA" | "MAURITIUS" | "MAYOTTE" | "MEXICO" | "MICRONESIA" | "MOLDOVA" | "MONACO" | "MONGOLIA" | "MONTENEGRO" | "MONTSERRAT" | "MOROCCO" | "MOZAMBIQUE" | "MYANMAR" | "NAMIBIA" | "NAURU" | "NEPAL" | "NETHERLANDS" | "NEW_CALEDONIA" | "NEW_ZEALAND" | "NICARAGUA" | "NIGER" | "NIGERIA" | "NIUE" | "NORFOLK_ISLAND" | "NORTHERN_MARIANA_ISLANDS" | "NORWAY" | "OMAN" | "PAKISTAN" | "PALAU" | "PALESTINE" | "PANAMA" | "PAPUA_NEW_GUINEA" | "PARAGUAY" | "PERU" | "PHILIPPINES" | "PITCAIRN" | "POLAND" | "PORTUGAL" | "PUERTO_RICO" | "QATAR" | "NORTH_MACEDONIA" | "ROMANIA" | "RUSSIA" | "RWANDA" | "REUNION" | "SAINT_BARTHELEMY" | "SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" | "SAINT_KITTS_AND_NEVIS" | "SAINT_LUCIA" | "SAINT_MARTIN" | "SAINT_PIERRE_AND_MIQUELON" | "SAINT_VINCENT_AND_THE_GRENADINES" | "SAMOA" | "SAN_MARINO" | "SAO_TOME_AND_PRINCIPE" | "SAUDI_ARABIA" | "SENEGAL" | "SERBIA" | "SEYCHELLES" | "SIERRA_LEONE" | "SINGAPORE" | "SINT_MAARTEN" | "SLOVAKIA" | "SLOVENIA" | "SOLOMON_ISLANDS" | "SOMALIA" | "SOUTH_AFRICA" | "SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" | "SOUTH_SUDAN" | "SPAIN" | "SRI_LANKA" | "SUDAN" | "SURINAME" | "SVALBARD_AND_JAN_MAYEN" | "SWEDEN" | "SWITZERLAND" | "SYRIAN_ARAB_REPUBLIC" | "TAIWAN" | "TAJIKISTAN" | "TANZANIA" | "THAILAND" | "TIMOR_LESTE" | "TOGO" | "TOKELAU" | "TONGA" | "TRINIDAD_AND_TOBAGO" | "TUNISIA" | "TURKEY" | "TURKMENISTAN" | "TURKS_AND_CAICOS_ISLANDS" | "TUVALU" | "UGANDA" | "UKRAINE" | "UNITED_ARAB_EMIRATES" | "UNITED_KINGDOM" | "UNITED_STATES_MINOR_OUTLYING_ISLANDS" | "UNITED_STATES" | "URUGUAY" | "UZBEKISTAN" | "VANUATU" | "VENEZUELA" | "VIETNAM" | "BRITISH_VIRGIN_ISLANDS" | "US_VIRGIN_ISLANDS" | "WALLIS_AND_FUTUNA" | "WESTERN_SAHARA" | "YEMEN" | "ZAMBIA" | "ZIMBABWE"documentIdstring
Match
^\d+$nationality?string
Value in
"AFGHAN" | "ALBANIAN" | "ALGERIAN" | "AMERICAN" | "AMERICANSAMOAN" | "ANDORRAN" | "ANGOLAN" | "ANGUILLIAN" | "ANTIGUANS" | "ANTARCTICAN" | "ARGENTINEAN" | "ARUBAN" | "ARMENIAN" | "AUSTRALIAN" | "AUSTRIAN" | "AZERBAIJANI" | "BAHAMIAN" | "BAHRAINI" | "BANGLADESHI" | "BARBADIAN" | "BARBUDANS" | "BATSWANA" | "BELARUSIAN" | "BELGIAN" | "BELIZEAN" | "BENINESE" | "BERMUDIAN" | "BHUTANESE" | "BOLIVIAN" | "BOSNIAN" | "BRAZILIAN" | "BRITISH" | "BRITISHINDIANOCEANTERRITORY" | "BRUNEIAN" | "BULGARIAN" | "BURKINABE" | "BURMESE" | "BURUNDIAN" | "CAMBODIAN" | "CAMEROONIAN" | "CANADIAN" | "CAPEVERDEAN" | "CAYMANISLANDER" | "CENTRALAFRICAN" | "CHADIAN" | "CHILEAN" | "CHINESE" | "CHRISTMASISLANDER" | "COCOSKEELINGISLANDER" | "COLOMBIAN" | "COMORAN" | "CONGOLESE" | "CONGOLESEREPUBLIC" | "COOKISLANDER" | "COSTARICAN" | "CROATIAN" | "CUBAN" | "CYPRIOT" | "CZECH" | "DANISH" | "DJIBOUTI" | "DOMINICAN" | "DOMINICANREPUBLIC" | "DUTCH" | "EASTTIMORESE" | "ECUADOREAN" | "EGYPTIAN" | "EMIRIAN" | "EQUATORIALGUINEAN" | "ERITREAN" | "ESTONIAN" | "ETHIOPIAN" | "FALKLANDISLANDER" | "FAROEISLANDER" | "FIJIAN" | "FILIPINO" | "FINNISH" | "FRENCH" | "FRENCHGUIANESE" | "FRENCHPOLYNESIAN" | "FRENCHSOUTHERNTERRITORIES" | "GABONESE" | "GAMBIAN" | "GEORGIAN" | "GERMAN" | "GHANAIAN" | "GIBRALTARIAN" | "GREEK" | "GREENLANDER" | "GRENADIAN" | "GUADELOUPEAN" | "GUAMANIAN" | "GUATEMALAN" | "GUERNSEYAN" | "GUINEABISSAUAN" | "GUINEAN" | "GUYANESE" | "HAITIAN" | "HEARDISLANDER" | "HERZEGOVINIAN" | "HONGKONGER" | "HONDURAN" | "HUNGARIAN" | "ICELANDER" | "INDIAN" | "INDONESIAN" | "IRANIAN" | "IRAQI" | "IRISH" | "ISLEOFMAN" | "ISRAELI" | "ITALIAN" | "IVORIAN" | "JAMAICAN" | "JAPANESE" | "JERSEYAN" | "JORDANIAN" | "KAZAKHSTANI" | "KENYAN" | "KIRIBATI" | "KITTIAN" | "KUWAITI" | "KYRGYZ" | "LAOTIAN" | "LATVIAN" | "LEBANESE" | "LIBERIAN" | "LIBYAN" | "LIECHTENSTEINER" | "LITHUANIAN" | "LUXEMBOURGER" | "MACANESE" | "MACEDONIAN" | "MALAGASY" | "MALAWIAN" | "MALAYSIAN" | "MALDIVIAN" | "MALIAN" | "MALTESE" | "MARSHALLESE" | "MARTINIQUAIS" | "MAURITANIAN" | "MAURITIAN" | "MAYOTTEAN" | "MEXICAN" | "MICRONESIAN" | "MOLDOVAN" | "MONACAN" | "MONGOLIAN" | "MONTENEGRIN" | "MONTSERRATIAN" | "MOROCCAN" | "MOSOTHO" | "MOTSWANA" | "MOZAMBICAN" | "MYANMARESE" | "NAMIBIAN" | "NAURUAN" | "NEPALESE" | "NEWCALEDONIAN" | "NEWZEALANDER" | "NICARAGUAN" | "NIGERIAN" | "NIGERIEN" | "NIUEAN" | "NORFOLKISLANDER" | "NORTHERNMARIANA" | "NORTHKOREAN" | "NORTHERNIRISH" | "NORWEGIAN" | "OMANI" | "PAKISTANI" | "PALAUAN" | "PALESTINIAN" | "PANAMANIAN" | "PAPUANEWGUINEAN" | "PARAGUAYAN" | "PERUVIAN" | "PITCAIRNISLANDER" | "POLISH" | "PORTUGUESE" | "PUERTORICAN" | "QATARI" | "REUNIONESE" | "ROMANIAN" | "RUSSIAN" | "RWANDAN" | "SAINTBARTHELEMIAN" | "SAINTHELENIAN" | "SAINTKITTIAN" | "SAINTLUCIAN" | "SAINTMARTINOIS" | "SAINTPIERREAN" | "SAINTVINCENTIAN" | "SALVADORAN" | "SAMOAN" | "SANMARINESE" | "SAOTOMEAN" | "SAUDI" | "SCOTTISH" | "SENEGALESE" | "SERBIAN" | "SEYCHELLOIS" | "SIERRALEONEAN" | "SINGAPOREAN" | "SINTMAARTENER" | "SLOVAKIAN" | "SLOVENIAN" | "SOLOMONISLANDER" | "SOMALI" | "SOUTHAFRICAN" | "SOUTHGEORGIAN" | "SOUTHKOREAN" | "SOUTHSUDANESE" | "SPANISH" | "SRILANKAN" | "SUDANESE" | "SURINAMER" | "SVALBARDER" | "SWAZI" | "SWEDISH" | "SWISS" | "SYRIAN" | "TAIWANESE" | "TAJIK" | "TANZANIAN" | "THAI" | "TOGOLESE" | "TOKELAUAN" | "TONGAN" | "TRINIDADIAN" | "TUNISIAN" | "TURKISH" | "TURKMEN" | "TURKSANDCAICOSISLANDER" | "TUVALUAN" | "UGANDAN" | "UKRAINIAN" | "URUGUAYAN" | "UZBEKISTANI" | "VANUATUAN" | "VENEZUELAN" | "VIETNAMESE" | "WELSH" | "WALLISANDFUTUNAN" | "WESTERNSAHARAN" | "YEMENITE" | "ZAMBIAN" | "ZIMBABWEAN"livenessRequiredboolean
emailstring
addressstring
citystring
statestring
postalCodestring
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,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}'const body = JSON.stringify({
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"documentCategory": "PASSPORT",
"documentCountry": "BRAZIL",
"documentId": "string",
"livenessRequired": true,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
})
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,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}`)
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,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}
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,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}""");
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,
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}
""", 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",
"individualId": "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.