Retry biometrics/acceptance for one person

POST

https://tenant.api.corpx.com/v1/accreditations/:accreditationId/persons/:cpf/retry

POST

/v1/accreditations/:accreditationId/persons/:cpf/retry

curl -X POST https://tenant.api.corpx.com/v1/accreditations/accreditationId/persons/cpf/retry \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "accreditationId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "status": "retrying",
  "person": {
    "personId": "prs_3b1c9a7f2e4d",
    "cpf": "12345678900",
    "name": "MARIA DA SILVA",
    "biometryStatus": "PENDING",
    "biometryLink": "https://onboarding.corpx.com/c/8c1f6a2e",
    "acceptanceStatus": "COMPLETED",
    "acceptanceLink": "https://onboarding.corpx.com/c/8c1f6a2e",
    "consentStatus": "PENDING",
    "consentLink": "https://onboarding.corpx.com/c/8c1f6a2e",
    "consentExpiresAt": "2026-02-20T08:33:39Z",
    "linkExpiresAt": "2026-02-20T08:33:39Z"
  }
}

Regenerates the facial-biometrics link (default flow), the acceptance link (external biometrics flow) or the authorization link (PENDING_CONSENT, CPF that already has an account) for one person of the accreditation — use it when the link expired or the capture failed. The new link is also delivered via the accreditation.biometry.link.created / accreditation.acceptance.link.created / accreditation.consent.link.created webhooks. BaaS integrators only.

Regenerates the facial-biometrics link (default flow), the acceptance link (external biometrics flow) or the authorization link (`PENDING_CONSENT`, CPF that already has an account) for one person of the accreditation — use it when the link expired or the capture failed. The new link is also delivered via the `accreditation.biometry.link.created` / `accreditation.acceptance.link.created` / `accreditation.consent.link.created` webhooks. **BaaS integrators only.**

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accreditationIdstringRequired

Accreditation (onboarding) identifier returned on creation.

cpfstringRequired

CPF of the person (11 digits).

Response

Retry accepted; the person snapshot reflects the new link when already available.

accreditationIdstringOptional

statusenumOptional

personobjectOptional

Per-person biometrics/acceptance progress.

Errors

404

Not Found Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors