GET/pix-biometric/enrollments/{id}

Recuperar vínculo

Retorna o vínculo, atualizado pela instituição enquanto não for final, de modo que um vínculo revogado no banco apareça como REVOKED.

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário do vínculo

Responses

200O vínculo

object

Uma conta vinculada (vínculo): a conta do pagador em uma instituição, vinculada ao dispositivo e ao navegador onde ele criou a chave de acesso. Somente o pagador cria um, na página de pagamento.

idrequiredstring (uuid)

Identificador primário do vínculo. Intenções de pagamento o referenciam como `enrollmentId`.

statusrequiredstring

CREATED: o pagador começou a vincular e não terminou. AUTHORIZED: o vínculo está ativo. REJECTED: o vínculo não foi concluído (rejeitado ou não finalizado a tempo). REVOKED: revogado no banco ou através da API. EXPIRED: o vínculo atingiu sua data de expiração ou ficou inativo na instituição. REJECTED, REVOKED e EXPIRED são finais.

CREATEDAUTHORIZEDREJECTEDREVOKEDEXPIRED

connectorrequiredobject | null

Instituição onde a conta está mantida

Any of:

option 1object

option 2null | null

debtorrequiredobject | null

A conta vinculada. Nula até que a instituição a reporte.

Any of:

option 1object

A conta vinculada, conforme a instituição a relatou.

option 2null | null

cpfrequiredstring | null

CPF do pagador, mascarado

cnpjrequiredstring | null

CNPJ do pagador, mascarado

customerIdrequiredstring (uuid) | null

Cliente de Pagamento da solicitação de pagamento onde o vínculo foi criado. Nulo quando o pagador digitou seu CPF.

limitsrequiredobject | null

Limites que o pagador definiu no banco, em BRL. Nulo até que a instituição os reporte.

Any of:

option 1object

option 2null | null

expiresAtrequiredstring (date-time) | null

Quando o vínculo expira, conforme definido pela instituição

dataConsentrequiredobject | null

Permissão para compartilhamento de saldo. Nulo quando a solicitação de pagamento não a ofereceu ou o pagador optou por não compartilhar.

Any of:

option 1object

option 2null | null

revokedByrequiredstring | null

Quem revogou o vínculo: BANK (o pagador ou a instituição, no banco) ou CLIENT (você, através da API). Nulo, a menos que `status` seja REVOKED.

BANKCLIENTPAYERnull

errorDetailrequiredobject | null

Motivo que a instituição deu quando o vínculo foi rejeitado

Any of:

option 1object

option 2null | null

createdAtrequiredstring (date-time)

Data em que o vínculo foi criado

updatedAtrequiredstring (date-time)

Data em que o vínculo foi atualizado pela última vez

Example response

json

{
  "id": "c91a5e2b-7d0f-4f3e-9a51-2f6b8e1d4c77",
  "status": "AUTHORIZED",
  "connector": {
    "id": 608,
    "name": "Santander",
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/208.svg"
  },
  "debtor": {
    "name": "John Doe",
    "taxNumber": "***.456.789-**",
    "bankAccount": {
      "agency": "1234",
      "account": "****4821",
      "name": "Santander"
    }
  },
  "cpf": "***.456.789-**",
  "cnpj": null,
  "customerId": "a2d4c1e8-5b7f-4c3a-9e2d-1f6b8c0d7e55",
  "limits": {
    "transaction": 1000,
    "daily": 3000,
    "dailyUsed": 149.9
  },
  "expiresAt": "2027-10-28T13:05:00.000Z",
  "dataConsent": null,
  "revokedBy": null,
  "errorDetail": null,
  "createdAt": "2026-10-28T13:02:00.000Z",
  "updatedAt": "2026-10-28T13:05:00.000Z"
}

curl -X GET \
  'https://api.pluggy.ai/pix-biometric/enrollments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "id": "c91a5e2b-7d0f-4f3e-9a51-2f6b8e1d4c77",
  "status": "AUTHORIZED",
  "connector": {
    "id": 608,
    "name": "Santander",
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/208.svg"
  },
  "debtor": {
    "name": "John Doe",
    "taxNumber": "***.456.789-**",
    "bankAccount": {
      "agency": "1234",
      "account": "****4821",
      "name": "Santander"
    }
  },
  "cpf": "***.456.789-**",
  "cnpj": null,
  "customerId": "a2d4c1e8-5b7f-4c3a-9e2d-1f6b8c0d7e55",
  "limits": {
    "transaction": 1000,
    "daily": 3000,
    "dailyUsed": 149.9
  },
  "expiresAt": "2027-10-28T13:05:00.000Z",
  "dataConsent": null,
  "revokedBy": null,
  "errorDetail": null,
  "createdAt": "2026-10-28T13:02:00.000Z",
  "updatedAt": "2026-10-28T13:05:00.000Z"
}