curl --request POST \
  --url https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "cpf": "000.000.000-00",
    "name": "Ana"
  }
}
'

{
  "process_external_id": "55555555-5555-4555-8555-555555555555",
  "hub_code": "padrao",
  "created": false,
  "url": "https://origination.example/sessao/parceiro/signed-token",
  "expires_at": "2026-11-14T10:12:00-03:00"
}

Referência da API

Criar indicação

Cria a indicação do cliente ou devolve o processo já aberto para o mesmo CPF. A resposta traz o link seguro da jornada, que você entrega ao cliente.

Criou: 201, created: true.
Reaproveitou um processo aberto do CPF (em qualquer hub do parceiro): 200, created: false, com link novo e o hub_code do processo existente, que pode ser outro hub do parceiro. Do novo pedido, só o CPF é usado: os demais dados do cliente e o valor são validados, mas não alteram o processo existente. O link anterior continua valendo até o próprio expires_at.
Repetir é seguro. Se a chamada sofreu timeout, reenvie com tranquilidade: o mesmo CPF devolve o mesmo processo, e por isso a API dispensa um Idempotency-Key.
Um hub inativo (o informado em hub_code ou o padrão) recusa a requisição com 403, mesmo que o CPF já tenha processo aberto.
Limite diário por CPF: padrão 3 encerramentos sem contrato por CPF por dia (fuso de São Paulo), configurável por parceiro. Atingido o limite, novas indicações daquele CPF respondem 429 CPF_DAILY_LIMIT_REACHED até a meia-noite de São Paulo. O reaproveitamento de processo aberto não é afetado pelo limite.

O valor e o prazo enviados em loan_request são um pedido, não um compromisso: o cliente pode ajustá-los na jornada. Consulte a faixa permitida em GET /ping.

Apenas customer.cpf e customer.name são obrigatórios. Dos campos opcionais, envie o que você já coletou; o cliente confirma e complementa os dados na jornada.

O CPF dos exemplos (000.000.000-00) é um marcador: a API o recusa com INVALID_CHECK_DIGIT. Substitua pelo CPF do cliente.

curl --request POST \
  --url https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "cpf": "000.000.000-00",
    "name": "Ana"
  }
}
'

{
  "process_external_id": "55555555-5555-4555-8555-555555555555",
  "hub_code": "padrao",
  "created": false,
  "url": "https://origination.example/sessao/parceiro/signed-token",
  "expires_at": "2026-11-14T10:12:00-03:00"
}

Authorizations

Authorization

string

header

required

Chave de API do parceiro, entregue pelo time de integrações da Wincred. Header: Authorization: Bearer <chave do parceiro> (o esquema Bearer não diferencia maiúsculas). Por segurança, chave ausente, malformada, inválida ou revogada recebem a mesma resposta: 401 UNAUTHENTICATED. Guarde a chave apenas no servidor e solicite a rotação ao time de integrações quando precisar trocá-la.

Headers

X-Request-Id

string

Identificador da requisição, até 64 caracteres [A-Za-z0-9_-]. Se faltar ou for inválido, a Wincred gera um. Volta no header X-Request-Id da resposta e no request_id de todo erro.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Body

application/json

customer

object

required

Dados do cliente. Textos são aparados (trim); texto opcional vazio ou só com espaços vale como ausente.

Show child attributes

hub_code

string

Código de um hub do parceiro. Sem ele, vale o hub padrão. Vazio ou só espaços equivale a ausente. Hub inexistente ou de outro parceiro: 422 HUB_NOT_FOUND. Mais de 32 caracteres: 422 OUT_OF_RANGE.

Maximum string length: 32

Example:

"padrao"

loan_request

object

Valor e prazo pedidos. Se o objeto vier, os dois campos são obrigatórios. É um pedido: o cliente pode trocar valor e prazo na jornada. Fora da faixa do hub: 422 LOAN_REQUEST_INVALID (faixa em GET /ping).

Show child attributes

Response

Já existia processo aberto para o CPF. A API devolveu o mesmo processo, com um link novo.

process_external_id

string<uuid>

required

Identificador do processo. Persista-o: é a chave do GET e de todo webhook.

hub_code

string

required

Hub do processo. No reaproveitamento, pode ser outro hub do parceiro.

created

boolean

required

false quando devolveu o processo aberto do CPF em vez de criar um.

url

string<uri>

required

Link da jornada do cliente. Gerado a cada pedido.

expires_at

string<date-time>

required

Validade do link, RFC 3339 com fuso de São Paulo. Link vencido sem termo assinado não muda o status (continua awaiting_client); reenvie o CPF para receber um link novo.

Introdução

Guia de integração

Referência da API

Eventos

Criar indicação

Authorizations

Headers

Body

Response