cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"consulta": {
"codigoId": "<string>"
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados"
payload = { "consulta": { "codigoId": "<string>" } }
headers = {
"IdempotencyKey": "<idempotencykey>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({consulta: {codigoId: '<string>'}})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados', 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.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados",
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([
'consulta' => [
'codigoId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados"
payload := strings.NewReader("{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"falha": true,
"json": "<string>"
}{
"msg": "<string>",
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"falha": true,
"json": "<string>"
}CAF
45 - Consultar Dados
cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"consulta": {
"codigoId": "<string>"
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados"
payload = { "consulta": { "codigoId": "<string>" } }
headers = {
"IdempotencyKey": "<idempotencykey>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({consulta: {codigoId: '<string>'}})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados', 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.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados",
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([
'consulta' => [
'codigoId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados"
payload := strings.NewReader("{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaCAFDados")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consulta\": {\n \"codigoId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"falha": true,
"json": "<string>"
}{
"msg": "<string>",
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"hasError": true,
"falha": true,
"json": "<string>"
}Em caso de perda do evento de webhook, é possível consultar os dados de uma análise específica.
Para executar a consulta é necessário o token gerado quando o link é criado pelo Onboarding ou pelo FaceAuthenticator. Sem esse token a consulta não pode ser realizada.
O retorno inclui os links das imagens enviadas pelo cliente selfie, frente e verso do documento cujo prazo de validade é de 1 hora; após esse período os links expiram.
Mostrar Exemplo de retorno completo
Mostrar Exemplo de retorno completo
O exemplo de retorno, mostrado no lado direito desta tela, está resumido. Na linha
"json": "<string>" o retorno do Bureau vem de forma serializada, sendo necessário deserializar para melhor visualização. Aqui está um exemplo do retorno deserializado que vem no campo "json":.{
"Tecnologia": 0,
"Data": {
"RequestId": "String",
"Id": "String",
"Status": "String",
"CustomStatus": "String",
"Type": "String",
"CreatedAt": "Date",
"Sections": {
"Ocr": {
"Name": "String",
"FirstDriverLicenseDate": "String",
"BirthDate": "String",
"BirthPlace": "String",
"IssueDate": "String",
"ExpirationDate": "String",
"Acc": "String",
"Rg": "String",
"RgIssuingAuthority": "String",
"RgIssueState": "String",
"Cpf": "String",
"RegistrationNumber": "String",
"Category": "String",
"Nationality": "String",
"FatherName": "String",
"MotherName": "String",
"MirrorNumber": "String",
"Notes": "String",
"PlaceOfIssue": "String",
"SecurityNumber": "String",
"RenachNumber": "String"
},
"Cpf": {
"StatusCode": "String",
"RegistrationStatusCode": "String",
"RegistrationStatusMessage": "String",
"Name": "String",
"BirthDate": "String",
"IssueDate": "String",
"DeathYear": "String",
"DeathMessage": "String"
},
"Facematch": {
"StatusCode": "String",
"Confidence": Numero,
"Identical": "String"
},
"OfficialData": {
"Code": "String",
"Confidence": Numero,
"Probability": "String"
}
},
"StatusReasons": [
{
"Category": "String",
"Description": "String",
"ResultStatus": "String",
"ResultCustomStatus": "String",
"Code": "String",
"Status": "String",
"ManualReprovalReasons": "String"
}
],
"Images": {
"Back": "String",
"Front": "String",
"Selfie": "String",
"SelectedFront": "String",
"SelectedBack": "String"
},
"Attributes": {
"Name": "String",
"Cpf": "String",
"BirthDate": "String",
"AcceptedTermsData": [
{
"Name": "String",
"Datetime": "Date",
"UserIp": "String",
"UserAgent": "String"
}
]
},
"AcceptedTermsData": "String",
"Address": "String",
"Relationships": "String",
"RelatedTransactions": "String",
"Files": "String"
}
}
Autorizações
Informe o token
Cabeçalhos
Corpo
application/jsontext/jsonapplication/*+json
Show child attributes
Show child attributes
Esta página foi útil?
⌘I

