GET/api/v2/baas/onboardings/proposals

Listar

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
pageOpcional
query

Página (inicia em 0).

Tipo:integer
limitOpcional
query

Itens por página.

Tipo:integer

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

Query

ParâmetroObrigatórioDescrição
pageNãoPágina (inicia em 0)
limitNãoItens por página

Resposta (200)

Envelope { data[], pagination }. Cada item em data[] segue o mesmo schema da consulta por ID: cadastro do titular, journey, onboardingNaturalPersons[], onboardingLegalPersons[]. Não inclui password.

Campo em paginationDescrição
pagePágina atual
limitItens por página
totalTotal de propostas do parceiro

Erros comuns

  • 401: HMAC ou token inválido
  • 403: scope baas.onboarding-proposals.read ausente

Códigos

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

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/onboardings/proposals?page=0&limit=50' \
  --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",
  params: { page: 0, limit: 50 },
  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"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
params = {"page": 0, "limit": 50}
response = requests.get(url, headers=headers, params=params)
print(response.text)
<?php
$curl = curl_init();
$opts = [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/onboardings/proposals?page=0&limit=50',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
];
curl_setopt_array($curl, $opts);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
  "data": [
    {
      "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",
      "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": []
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 50,
    "total": 1
  }
}

A listagem não traz password nem códigos OTP. Use Consultar para email_verification_code e phone_verification_code antes do PATCH.