Obtém as URLs de assinaturas relacionadas à operação

Lista e filtra registros de Credit Note.

Visão geral

Obtém as URLs de assinaturas relacionadas à operação.

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string (uuid)`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`version`	path	`string`	obrigatório	—	`1`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200 — retorna uma lista (array) de objetos.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`creditNoteId`	`string (uuid)`	opcional	Id da operação de crédito	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`personId`	`string (uuid)`	opcional	Id do tomador da operação de crédito	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`personCellPhone`	`string`	opcional	Telefone celular do tomador	—	`"11987654321"`
`personEmail`	`string`	opcional	Email do tomador	—	`"cliente@exemplo.com.br"`
`url`	`string`	opcional	Link de assinatura do contrato	—	`"https://exemplo.com.br/callback"`
`createdAt`	`string (date-time)`	opcional	Data de criação do link	—	`"2025-08-11T13:45:00Z"`
`displayName`	`string`	opcional	Nome do tomador da operação	—	`"Fulano de Tal"`

Exemplo de resposta

[
  {
    "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personCellPhone": "11987654321",
    "personEmail": "cliente@exemplo.com.br",
    "url": "https://exemplo.com.br/callback",
    "createdAt": "2025-08-11T13:45:00Z",
    "displayName": "Fulano de Tal"
  }
]

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignUrl" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignUrl";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignUrl`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads