KYC
Iniciar sessão PF
POST
/
api
/
v1
/
users
/
kyc
/
sessions
/
natural-person
Start PF session
curl --request POST \
--url https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"externalUserId": "<string>",
"documentNumber": "<string>",
"fullName": "<string>",
"birthDate": "<string>",
"motherName": "<string>",
"email": "jsmith@example.com",
"isPoliticallyExposedPerson": true,
"country": "<string>",
"socialName": "<string>",
"phoneNumber": "<string>",
"taxResidence": [
{
"country": "<string>",
"tin": "<string>"
}
],
"selfCertification": true,
"monthlyIncomeCents": 1
}
'import requests
url = "https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person"
payload = {
"externalUserId": "<string>",
"documentNumber": "<string>",
"fullName": "<string>",
"birthDate": "<string>",
"motherName": "<string>",
"email": "jsmith@example.com",
"isPoliticallyExposedPerson": True,
"country": "<string>",
"socialName": "<string>",
"phoneNumber": "<string>",
"taxResidence": [
{
"country": "<string>",
"tin": "<string>"
}
],
"selfCertification": True,
"monthlyIncomeCents": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: '<string>',
documentNumber: '<string>',
fullName: '<string>',
birthDate: '<string>',
motherName: '<string>',
email: 'jsmith@example.com',
isPoliticallyExposedPerson: true,
country: '<string>',
socialName: '<string>',
phoneNumber: '<string>',
taxResidence: [{country: '<string>', tin: '<string>'}],
selfCertification: true,
monthlyIncomeCents: 1
})
};
fetch('https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person', 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.brlp.io/api/v1/users/kyc/sessions/natural-person",
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([
'externalUserId' => '<string>',
'documentNumber' => '<string>',
'fullName' => '<string>',
'birthDate' => '<string>',
'motherName' => '<string>',
'email' => 'jsmith@example.com',
'isPoliticallyExposedPerson' => true,
'country' => '<string>',
'socialName' => '<string>',
'phoneNumber' => '<string>',
'taxResidence' => [
[
'country' => '<string>',
'tin' => '<string>'
]
],
'selfCertification' => true,
'monthlyIncomeCents' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.brlp.io/api/v1/users/kyc/sessions/natural-person"
payload := strings.NewReader("{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.brlp.io/api/v1/users/kyc/sessions/natural-person")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": null,
"data": {
"sessionId": "kyc_ab12",
"type": "PF",
"provider": "bigdatacorp",
"status": "PENDING",
"webViewUrl": "https://..."
}
}Autorizações
partnerApiKeyhmacAuth
Bearer API key (recommended). Format: Bearer sk_live_<hex>. Send the key directly - no signature, nonce or timestamp. Create/revoke keys in the dashboard or via /partners/me/api-keys. Accepted on the same routes as the HMAC scheme. - API key Bearer (recomendada), aceita nas mesmas rotas que o esquema HMAC.
Corpo
application/json
Required string length:
1 - 128Required string length:
5 - 30Required string length:
1 - 120Required string length:
8 - 30Required string length:
1 - 120Maximum string length:
100Opções disponíveis:
CPF, CNPJ, RG, PASSPORT, SSN, DNI, CURP, RUT, CC, NIT, OTHER Required string length:
2Maximum string length:
120Maximum string length:
20Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Intervalo obrigatório:
x >= 0Opções disponíveis:
salary, business_income, investments, inheritance, savings, crypto_trading, freelance, real_estate, other Resposta
Default Response
⌘I
Start PF session
curl --request POST \
--url https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"externalUserId": "<string>",
"documentNumber": "<string>",
"fullName": "<string>",
"birthDate": "<string>",
"motherName": "<string>",
"email": "jsmith@example.com",
"isPoliticallyExposedPerson": true,
"country": "<string>",
"socialName": "<string>",
"phoneNumber": "<string>",
"taxResidence": [
{
"country": "<string>",
"tin": "<string>"
}
],
"selfCertification": true,
"monthlyIncomeCents": 1
}
'import requests
url = "https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person"
payload = {
"externalUserId": "<string>",
"documentNumber": "<string>",
"fullName": "<string>",
"birthDate": "<string>",
"motherName": "<string>",
"email": "jsmith@example.com",
"isPoliticallyExposedPerson": True,
"country": "<string>",
"socialName": "<string>",
"phoneNumber": "<string>",
"taxResidence": [
{
"country": "<string>",
"tin": "<string>"
}
],
"selfCertification": True,
"monthlyIncomeCents": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: '<string>',
documentNumber: '<string>',
fullName: '<string>',
birthDate: '<string>',
motherName: '<string>',
email: 'jsmith@example.com',
isPoliticallyExposedPerson: true,
country: '<string>',
socialName: '<string>',
phoneNumber: '<string>',
taxResidence: [{country: '<string>', tin: '<string>'}],
selfCertification: true,
monthlyIncomeCents: 1
})
};
fetch('https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person', 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.brlp.io/api/v1/users/kyc/sessions/natural-person",
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([
'externalUserId' => '<string>',
'documentNumber' => '<string>',
'fullName' => '<string>',
'birthDate' => '<string>',
'motherName' => '<string>',
'email' => 'jsmith@example.com',
'isPoliticallyExposedPerson' => true,
'country' => '<string>',
'socialName' => '<string>',
'phoneNumber' => '<string>',
'taxResidence' => [
[
'country' => '<string>',
'tin' => '<string>'
]
],
'selfCertification' => true,
'monthlyIncomeCents' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.brlp.io/api/v1/users/kyc/sessions/natural-person"
payload := strings.NewReader("{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.brlp.io/api/v1/users/kyc/sessions/natural-person")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brlp.io/api/v1/users/kyc/sessions/natural-person")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"fullName\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"motherName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"isPoliticallyExposedPerson\": true,\n \"country\": \"<string>\",\n \"socialName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxResidence\": [\n {\n \"country\": \"<string>\",\n \"tin\": \"<string>\"\n }\n ],\n \"selfCertification\": true,\n \"monthlyIncomeCents\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": null,
"data": {
"sessionId": "kyc_ab12",
"type": "PF",
"provider": "bigdatacorp",
"status": "PENDING",
"webViewUrl": "https://..."
}
}