Links de contratação

O link é o ponto de partida de toda contratação. Ele é pessoal: fica vinculado a um CPF e ao seu canal.

Criar

curl (Linux/Mac)

curl -s -X POST https://sandbox-api.eagleix-corban.com.br/v1/links \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: indicacao-2026-000123" \
  -d '{"cpf":"52998224725","celular":"11987654321","referenciaExterna":"promotor-42"}'

PowerShell (curl.exe)

$body = '{"cpf":"52998224725","celular":"11987654321","referenciaExterna":"promotor-42"}'
$body | curl.exe -s -X POST "https://sandbox-api.eagleix-corban.com.br/v1/links" -H "Authorization: Bearer $env:ACCESS_TOKEN" -H "Content-Type: application/json" -H "Idempotency-Key: indicacao-2026-000123" --data-binary "@-"

PowerShell (Invoke-RestMethod)

$h = @{ Authorization = "Bearer $($env:ACCESS_TOKEN)"; "Idempotency-Key" = "indicacao-2026-000123" }
$body = '{"cpf":"52998224725","celular":"11987654321","referenciaExterna":"promotor-42"}'
Invoke-RestMethod -Method Post -Uri "https://sandbox-api.eagleix-corban.com.br/v1/links" `
  -Headers $h `
  -ContentType "application/json" -Body $body

Node.js

const res = await fetch('https://sandbox-api.eagleix-corban.com.br/v1/links', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'indicacao-2026-000123',
  },
  body: JSON.stringify({
    "cpf": "52998224725",
    "celular": "11987654321",
    "referenciaExterna": "promotor-42"
  }),
})
const data = await res.json()

Python

import os, requests

r = requests.request(
    "POST",
    "https://sandbox-api.eagleix-corban.com.br/v1/links",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}", "Idempotency-Key": "indicacao-2026-000123"},
    json={
      "cpf": "52998224725",
      "celular": "11987654321",
      "referenciaExterna": "promotor-42"
    },
    timeout=15,
)
print(r.status_code, r.json())

Postman

Em Import, escolha Raw text e cole o comando. A variável {{ACCESS_TOKEN}} é criada na coleção.

curl --location --request POST 'https://sandbox-api.eagleix-corban.com.br/v1/links' \
  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: indicacao-2026-000123' \
  --data '{"cpf":"52998224725","celular":"11987654321","referenciaExterna":"promotor-42"}'

Campo	Obrigatório	Descrição
cpf	sim	11 dígitos, sem pontuação, com dígitos verificadores válidos.
celular	não	DDD + 9 dígitos. Sugerido para o envio do código SMS.
referenciaExterna	não	Identificador da indicação no seu sistema (até 200 caracteres). É devolvido em todos os webhooks.
Idempotency-Key (header)	não	Identificador único do pedido no seu sistema (8 a 100 caracteres). Se não for enviado, o sistema gera um UUID. Veja Idempotência.

Resposta 201:

{
  "id": "fd6e64ed-5ebe-434d-9351-983ff129e9c0",
  "url": "https://sandbox-contratar.eagleix-corban.com.br/pt/c/…",
  "status": "CRIADO",
  "ambiente": "SANDBOX",
  "cpfMascarado": "***.982.247-**",
  "referenciaExterna": "promotor-42",
  "expiraEm": "2026-10-15T18:00:00Z",
  "criadoEm": "2026-10-14T18:00:00Z"
}

Cuidado

A url só é devolvida nesta resposta. O token contido nela é de uso pessoal: não o registre em logs, não o reutilize entre clientes e envie-o apenas ao cliente a quem se destina.

Idempotência

Uma chamada pode falhar por problema de rede ou timeout, sem que você saiba se o link foi criado. Para poder repeti-la com segurança, envie o header Idempotency-Key:

• Mesma chave, mesmos dados: devolve o mesmo link (200 em vez de 201).
• Mesma chave, dados diferentes: 409. Use uma chave por indicação.

Após um 503 ou um timeout, repita a chamada com a mesma chave.

Sem o header

O Idempotency-Key é opcional. Se não for enviado, o sistema gera um UUID para a chamada e cada requisição cria um novo link, sem proteção contra repetição. Se você repetir a chamada após um erro de rede, o mesmo cliente pode acabar com dois links. Para evitar isso, envie sempre a sua própria chave.

Status do link

Status	Quando
CRIADO	Link gerado e ainda não aberto pelo cliente.
ABERTO	O cliente abriu o link.
EM_ANDAMENTO	O cliente confirmou o celular e está percorrendo a jornada.
EXPIRADO	O prazo de 24 horas terminou sem conclusão. O link deixa de abrir.
CONCLUIDO / CANCELADO	Link encerrado pela operação. O link deixa de abrir.

Nota

Para saber se o cliente enviou a proposta e em que situação ela está, use o objeto proposta da consulta ou os webhooks, e não o status do link.

Consultar

curl (Linux/Mac)

curl -s -X GET https://sandbox-api.eagleix-corban.com.br/v1/links/$LINK_ID \
  -H "Authorization: Bearer $ACCESS_TOKEN"

PowerShell (curl.exe)

curl.exe -s -X GET "https://sandbox-api.eagleix-corban.com.br/v1/links/$($env:LINK_ID)" -H "Authorization: Bearer $env:ACCESS_TOKEN"

PowerShell (Invoke-RestMethod)

$h = @{ Authorization = "Bearer $($env:ACCESS_TOKEN)" }
Invoke-RestMethod -Method Get -Uri "https://sandbox-api.eagleix-corban.com.br/v1/links/$($env:LINK_ID)" `
  -Headers $h

Node.js

const res = await fetch(`https://sandbox-api.eagleix-corban.com.br/v1/links/${process.env.LINK_ID}`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
  },
})
const data = await res.json()

Python

import os, requests

r = requests.request(
    "GET",
    f"https://sandbox-api.eagleix-corban.com.br/v1/links/{os.environ['LINK_ID']}",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
    timeout=15,
)
print(r.status_code, r.json())

Postman

Em Import, escolha Raw text e cole o comando. A variável {{ACCESS_TOKEN}} é criada na coleção.

curl --location --request GET 'https://sandbox-api.eagleix-corban.com.br/v1/links/{{LINK_ID}}' \
  --header 'Authorization: Bearer {{ACCESS_TOKEN}}'

A resposta traz o status do link e, se o cliente já enviou a proposta, o objeto proposta com numero, status e criadaEm. A url não é devolvida na consulta. Links de outro canal respondem 404.