Acessar minha contaAbrir uma conta
POST/api/v2/baas/key-managements/consult

Consultar chave

Produto BaaS (titular). Requer Bearer JWT do login da conta e assinatura HMAC obrigatória. Scope: baas.key-managements.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

Autenticação e headers

Requer Bearer token do login da conta e assinatura HMAC obrigatórios. Scope: baas.key-managements.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

Corpo

CampoTipoDescrição
keystringChave Pix a consultar no DICT

Exige ao menos uma chave active na conta. document retorna mascarado.

Códigos

CódigoDescrição
200OK
201Recurso criado
400Parâmetros inválidos
401Token ou HMAC inválido
403Scope ausente
404Não encontrado
422Validação ou regra de negócio
500Erro interno

Notas

  • Consultar chave de terceiro no DICT (pré-requisito de cash-out por chave).
  • Técnica: Chaves Pix.
  • Visão geral BaaS: Sobre o BaaS.
curl --request POST \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/key-managements/consult' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}' \
  --data '{
  "key": "[email protected]"
}'

const axios = require("axios");

const data = {
  key: "[email protected]",
};

axios({
  method: "post",
  url: "https://api-h.nuvende.com.br/api/v2/baas/key-managements/consult",
  headers: {
    "Content-Type": "application/json",
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
  data,
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));

import json
import requests

url = "https://api-h.nuvende.com.br/api/v2/baas/key-managements/consult"
payload = {
    "key": "[email protected]",
}
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.text)

<?php
$curl = curl_init();
$opts = [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/key-managements/consult',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "key": "[email protected]"
}',
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    '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;

{
  "key": "[email protected]",
  "key_type": 2,
  "ispb": "60701190",
  "agency": "0001",
  "account": "1234567",
  "account_type": 0,
  "person_type": 0,
  "document": "111***77735",
  "name": "João Recebedor Exemplo",
  "favorite": false,
  "bank_name": "Banco Exemplo S.A."
}

{
  "message": "You don't have any key to be consult"
}

{
  "message": "Key not found"
}