Get Registration Update Status

Time	Status	User Agent
Retrieving recent requests…

Endpoint

GET /v3/onboarding/registration-update/status

Headers

Parameter	Type	Description	Required or Optional	Example
Authorization	String	Bearer access token of the account holder.	required	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIn0.example

This endpoint does not use X-Onboarding-Token or an HMAC signature. There is no request body.

Request Examples

Read whether a cadastral update is due:

GET /v3/onboarding/registration-update/status
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIn0.example

Response Details

No update required:

{
  "status": "NOT_REQUIRED",
  "deadline": null,
  "days_remaining": null,
  "blocked": false,
  "can_start": false,
  "onboarding_link": null,
  "rejection_reason": null
}

Deadline expired, the account must start an update:

{
  "status": "ACTION_REQUIRED",
  "deadline": "2026-08-01",
  "days_remaining": -15,
  "blocked": true,
  "can_start": true,
  "onboarding_link": null,
  "rejection_reason": null
}

Update in progress on the hosted pages:

{
  "status": "IN_PROGRESS",
  "deadline": "2026-08-01",
  "days_remaining": -15,
  "blocked": true,
  "can_start": false,
  "onboarding_link": "https://links.example.com/onboarding/update_journey_id",
  "rejection_reason": null
}

Previous update was rejected and can be started again:

{
  "status": "ACTION_REQUIRED",
  "deadline": "2026-08-01",
  "days_remaining": -15,
  "blocked": true,
  "can_start": true,
  "onboarding_link": null,
  "rejection_reason": "Document photo is not readable"
}

Field	Type	Description
status	String	Current state of the cadastral update for this account. See the table below.
deadline	String	Registration-update deadline as `YYYY-MM-DD`. `null` when no deadline is set or the update is no longer required.
days_remaining	Integer	Days until the deadline. Negative when the deadline is already in the past. `null` when there is no deadline.
blocked	Boolean	`true` when the deadline is in the past. Cash-out for the account is blocked in that situation.
can_start	Boolean	`true` only when `POST /v3/onboarding/registration-update` is allowed: the deadline has expired and `status` is `ACTION_REQUIRED`.
onboarding_link	String	Hosted update link, filled only while `status` is `IN_PROGRESS`. Send the end user to this URL. `null` otherwise.
rejection_reason	String	Reason of the last refusal, when a previous update was rejected and a new one can be started. `null` otherwise.

Status values:

Value	Meaning	What your application should do
NOT_REQUIRED	No cadastral update is due. Either there is no deadline, or the last update was approved.	Hide the update flow.
ACTION_REQUIRED	The account must update its registration. It has not started, or the previous attempt was refused.	If `can_start` is `true`, call the submit endpoint.
IN_PROGRESS	An update was started and the hosted pages are still open.	Send the end user to `onboarding_link` and keep polling this endpoint.
IN_REVIEW	The update finished the automated checks and is waiting for the final decision.	Keep polling. Show the end user that the registration is under review.

Error Responses

HTTP Code	Error Message	Description
401	Unauthorized	Missing or invalid Bearer token.

When the session is not linked to an account, the endpoint still answers 200 with status NOT_REQUIRED and the other fields empty. It does not use that case as a 404.

Business Rules

Read this before starting an update:

Call this endpoint first. Only call POST /v3/onboarding/registration-update when can_start is true.
can_start is true only when status is ACTION_REQUIRED and blocked is true (the deadline is already in the past).

Polling:

While status is IN_PROGRESS or IN_REVIEW, poll this endpoint every 10 to 30 seconds.
Stop when status becomes NOT_REQUIRED (approved) or ACTION_REQUIRED again (rejected, a new attempt can start).

Deadline:

days_remaining counts calendar days until deadline. A negative value means the deadline has passed.
blocked follows the same rule: true only after the deadline.