Acessar minha contaAbrir uma conta
GET/api/v2/baas/onboardings/proposals/{proposalId}

Consultar

Produto BaaS (parceiro). Requer Bearer JWT e assinatura HMAC obrigatória. Scope: baas.onboarding-proposals.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

Autenticação e headers

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

Envie X-Signature, X-Timestamp e X-Nonce em todo pedido assinado. Veja Autenticação do parceiro.

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 retornado no POST de proposta

Resposta (200)

Objeto da proposta. Use antes de cada PATCH. Não inclui password.

CampoDescrição
idID da proposta
documentCPF ou CNPJ do titular
full_name, social_name, email, phone, birth_dateCadastro do titular
monthly_incomeRenda mensal quando informada
email_verification_code, phone_verification_codeOTP voláteis para o próximo PATCH
journeyEtapa atual (step, last_step, person_type)
natural_person_journey, legal_person_journeyJornadas PF/PJ quando iniciadas
onboardingNaturalPersons[]PF vinculadas (id, status, address, account, journey)
onboardingLegalPersons[]PJ vinculadas (id, owners, company, account, journey)
created_at, updated_atY-m-d H:i:s ou ISO 8601

Erros comuns

CódigoCorpoCausa
400message: Not FoundproposalId inválido ou ausente

Códigos

CódigoDescrição
200OK
400Parâmetros inválidos
401Token ou HMAC inválido
403Scope ausente
404Proposta não encontrada
500Erro interno

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/onboardings/proposals/352' \
  --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");

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/baas/onboardings/proposals/352",
  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/proposals/352"
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/proposals/352',
  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": 352,
  "document": "11144477735",
  "full_name": "Maria Pagadora Exemplo",
  "social_name": "Maria Exemplo",
  "email": "[email protected]",
  "phone": "11987654321",
  "birth_date": "1990-05-20",
  "monthly_income": "5000.00",
  "email_verification_code": "123456",
  "phone_verification_code": "654321",
  "created_at": "2025-01-15 10:00:00",
  "updated_at": "2025-01-15 11:00:00",
  "journey": {
    "id": 5062,
    "person_type": null,
    "last_step": null,
    "step": "Baas",
    "created_at": "2025-01-15T10:00:00.000000Z",
    "updated_at": "2025-01-15T11:00:00.000000Z"
  },
  "natural_person_journey": null,
  "legal_person_journey": null,
  "onboardingNaturalPersons": [
    {
      "id": 268,
      "full_name": "Maria Pagadora Exemplo",
      "document": "11144477735",
      "status": "pending",
      "onboarding_proposal_id": 352,
      "journey": {
        "id": 5100,
        "step": "documents",
        "person_type": "natural_person",
        "created_at": "2025-01-15T11:00:00.000000Z"
      }
    }
  ],
  "onboardingLegalPersons": []
}

{
  "message": "Not Found"
}