GET/api/v2/baas/onboardings/{proposalId}/natural-persons/{personId}

Consultar

Produto BaaS (parceiro). Requer Bearer JWT e assinatura HMAC obrigatória. Scope: baas.onboarding-natural-persons.read. Guia: documentação técnica.

Parâmetros

AcceptObrigatório
header
Tipo:string
X-SignatureObrigatório
header

Assinatura HMAC-SHA256 da requisição (hex).

Tipo:string
X-TimestampObrigatório
header

Timestamp Unix (segundos, UTC) usado na assinatura.

Tipo:string
X-NonceObrigatório
header

Nonce único por requisição (anti-replay).

Tipo:string
proposalIdObrigatório
path
Tipo:string
personIdObrigatório
path
Tipo:string

Autenticação e headers

Requer Bearer token e assinatura HMAC obrigatórios. Scope: baas.onboarding-natural-persons.read.

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json
X-SignatureSimAssinatura HMAC
X-TimestampSimTimestamp da assinatura
X-NonceSimNonce único por requisição

Path

ParâmetroDescrição
proposalIdID da proposta
personIdID da pessoa física

Resposta (200)

CampoDescrição
id, document, statusIdentificação e status KYC
full_name, social_name, email, phone, birth_dateCadastro
monthly_gross_income, is_political_exposedDados financeiros e PEP
accepted_terms_at, onboarding_proposal_idTermos e vínculo com proposta
email_verification_codeOTP volátil quando exigido
addressCEP, logradouro, cidade, UF
journeyEtapa do fluxo PF
accountConta bancária quando aprovada
files[]Metadados dos documentos (sem base64 em path)

Notas

  • Técnica: Pessoa física.
  • Consulte antes de cada PATCH e copie OTP fresco.
curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/onboardings/352/natural-persons/268' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'
const axios = require("axios");

const data = {};

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/baas/onboardings/352/natural-persons/268",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));
import requests

url = "https://api-h.nuvende.com.br/api/v2/baas/onboardings/352/natural-persons/268"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.get(url, headers=headers)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/onboardings/352/natural-persons/268',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
  "id": "268",
  "document": "111***77735",
  "status": "pending",
  "full_name": "Maria Pagadora Exemplo",
  "social_name": "Maria Exemplo",
  "email": "[email protected]",
  "phone": "11987654321",
  "birth_date": "1990-05-20",
  "accepted_terms_at": "2025-01-15 10:30:00",
  "notifications_enabled": false,
  "email_verification_code": "123456",
  "address": {
    "zip_code": "01310100",
    "street": "Avenida Exemplo",
    "number": "1000",
    "complement": "Sala 1"
  },
  "files": [
    {
      "type": "document",
      "side": "front",
      "status": "pending"
    },
    {
      "type": "document",
      "side": "back",
      "status": "pending"
    },
    {
      "type": "selfie",
      "status": "pending"
    }
  ],
  "created_at": "2025-01-15T10:05:00Z",
  "updated_at": "2025-01-15T11:00:00Z"
}