curl --request GET \
--url https://api.malvo.io/identity \
--header 'X-API-KEY: <api-key>'const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.malvo.io/identity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.malvo.io/identity"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.malvo.io/identity",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "42888436-62f5-49d2-8cf9-e312c7939509",
"fullName": "Francisco Sousa",
"companyName": "Empresa Exemplo Ltda",
"document": "076.630.975-48",
"taxNumber": "38.512.121/0001-95",
"documentType": "CPF",
"jobTitle": "Comercial",
"birthDate": "1991-05-01T00:00:00.000Z",
"establishmentCode": "001",
"establishmentName": "Estabelecimento Exemplo",
"addresses": [
{
"fullAddress": "Av. Lúcio Costa 1234, Copacabana, Rio de Janeiro, Brasil",
"country": "Brasil",
"state": "RJ",
"city": "Rio de Janeiro",
"postalCode": "22620-171",
"primaryAddress": "Av. Lúcio Costa, 1234",
"type": "Personal",
"additionalInfo": "Apartamento 101"
}
],
"phoneNumbers": [
{
"type": "Personal",
"value": "+54 911 12345678"
}
],
"emails": [
{
"type": "Personal",
"value": "maria.silva@exemplo.com.br"
}
],
"relations": [
{
"type": "Father",
"name": "Juan Gonzalez"
},
{
"type": "Spouse",
"name": "Laura Garcia"
}
],
"createdAt": "2020-09-30T14:38:12.724Z",
"updatedAt": "2020-09-30T14:38:12.724Z"
}{
"code": 400,
"message": "itemId must be a UUID"
}{
"code": 403,
"codeDescription": "API_KEY_MISSING_OR_INVALID",
"message": "Missing or invalid authorization token"
}{
"code": 404,
"codeDescription": "IDENTITY_NOT_FOUND",
"message": "identity not found"
}{
"code": 500,
"codeDescription": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}Buscar identidade por item
Retorna os dados cadastrais do titular do item informado. A resposta é um objeto único IdentityResponse — NÃO é um envelope paginado.
curl --request GET \
--url https://api.malvo.io/identity \
--header 'X-API-KEY: <api-key>'const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.malvo.io/identity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.malvo.io/identity"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.malvo.io/identity",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "42888436-62f5-49d2-8cf9-e312c7939509",
"fullName": "Francisco Sousa",
"companyName": "Empresa Exemplo Ltda",
"document": "076.630.975-48",
"taxNumber": "38.512.121/0001-95",
"documentType": "CPF",
"jobTitle": "Comercial",
"birthDate": "1991-05-01T00:00:00.000Z",
"establishmentCode": "001",
"establishmentName": "Estabelecimento Exemplo",
"addresses": [
{
"fullAddress": "Av. Lúcio Costa 1234, Copacabana, Rio de Janeiro, Brasil",
"country": "Brasil",
"state": "RJ",
"city": "Rio de Janeiro",
"postalCode": "22620-171",
"primaryAddress": "Av. Lúcio Costa, 1234",
"type": "Personal",
"additionalInfo": "Apartamento 101"
}
],
"phoneNumbers": [
{
"type": "Personal",
"value": "+54 911 12345678"
}
],
"emails": [
{
"type": "Personal",
"value": "maria.silva@exemplo.com.br"
}
],
"relations": [
{
"type": "Father",
"name": "Juan Gonzalez"
},
{
"type": "Spouse",
"name": "Laura Garcia"
}
],
"createdAt": "2020-09-30T14:38:12.724Z",
"updatedAt": "2020-09-30T14:38:12.724Z"
}{
"code": 400,
"message": "itemId must be a UUID"
}{
"code": 403,
"codeDescription": "API_KEY_MISSING_OR_INVALID",
"message": "Missing or invalid authorization token"
}{
"code": 404,
"codeDescription": "IDENTITY_NOT_FOUND",
"message": "identity not found"
}{
"code": 500,
"codeDescription": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}Authorizations
Chave de API obrigatória em todos os endpoints. Envie no header X-API-KEY: <apiKey>.
Query Parameters
Identificador primário do item.
Response
Objeto IdentityResponse.
Dados cadastrais do titular do item. Conectores diretos retornam apenas os campos core. Conexões reguladas do Open Finance trazem extras: qualifications e financialRelationships, além de campos exclusivos de PF (ex.: socialName, sex, maritalStatus, nationality, otherDocuments, passport) e de PJ (ex.: incorporationDate, parties, businessOtherDocuments, companiesCnpj). Todos os campos além de id e itemId são opcionais/nullable.
Id da identidade.
Item vinculado.
Nome do titular.
Documento principal formatado (ex.: 076.630.975-48).
Tipo do documento coletado (ex.: CPF).
CNPJ associado a uma conta empresarial.
Profissão/cargo.
Para conectores empresariais, a razão social.
Apenas para conectores PAYMENT_ACCOUNT.
Apenas para conectores PAYMENT_ACCOUNT.
Perfil de investidor.
Conservative, Moderate, Aggressive, null Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Extra do Open Finance (Regulado). Inclui companyCnpj (obrigatório), occupationCode, occupationDescription, informedIncome, informedPatrimony, economicActivities (PJ) e informedRevenue (PJ).
Show child attributes
Show child attributes
Extra do Open Finance (Regulado). Inclui startDate, productsServicesType, procurators (obrigatórios), accounts, portabilitiesReceived (PF), paychecksBankLink (PF).
Show child attributes
Show child attributes