Request a hosted PIN reset
Deprecated on 2026-10-07. Use POST /v1/people/pin/reset-request. This
alias keeps the same body and the same response and opens a reset for
the person. The rate limit is per person, shared with the new route.
Returns a CorpX page URL. The operator opens it, completes the facial check for the CPF on the request and, if the check is approved, chooses the new PIN on that same page. The integrator never sees or chooses the PIN. The body does not accept it.
Requires scope pin.manage and an existing PIN for that person,
including a PIN invalidated by DELETE. With no PIN, the response is
409 pin_reset_not_enrolled. When hosted reset is not enabled for
the tenant, the response is 403 feature_disabled.
Optional displayMessage is one line of plain text, at most 240
characters, without HTML, Markdown or links. The page shows that text
as-is. The link expires in 30 minutes. Five requests per operator per
hour; a new request expires earlier open links for the same operator.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Optional client-generated idempotency token (recommended for safe retries).