SimPayDocs

    Submit Registration Update

    Starts a cadastral update for the authenticated account when the registration deadline has already expired. The document and the PF/PJ type come from the account; the body carries only the contact e-mail.

    POSThttps://api.somossimpay.com.br/v3/onboarding/registration-update
    curl --request POST \
  --url 'https://api.somossimpay.com.br/v3/onboarding/registration-update' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "financeiro@example.com"
}'
    Response200
    {
  "worked": true,
  "onboarding_requisition_id": 20401,
  "onboarding_link": "https://links.example.com/onboarding/update_journey_id",
  "liveness_url": null,
  "liveness_status": null,
  "access_token": null,
  "status": "PENDING"
}

    Endpoint

    POST /v3/onboarding/registration-update

    This flow is for an existing account, not for opening a new one. The document already has a registration. Call it only when Get Registration Update Status returns can_start as true.

    Headers

    ParameterTypeDescriptionRequired or OptionalExample
    AuthorizationStringBearer access token of the account holder.requiredBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIn0.example
    Content-TypeStringMedia type of the request body. Must be application/json.requiredapplication/json

    This endpoint does not use X-Onboarding-Token or an HMAC signature.

    Body Details

    {
  "email": "financeiro@example.com"
}
    FieldTypeDescriptionRequired or Optional
    emailStringContact e-mail used for the cadastral update. Must be a valid e-mail address; it is stored in lower case.required

    The CPF or CNPJ and whether the update is PF or PJ are taken from the authenticated account. Do not send them in the body.

    Request Examples

    Start a cadastral update:

    POST /v3/onboarding/registration-update
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIn0.example
Content-Type: application/json

{
  "email": "financeiro@example.com"
}

    Response Details

    {
  "worked": true,
  "onboarding_requisition_id": 20401,
  "onboarding_link": "https://links.example.com/onboarding/update_journey_id",
  "liveness_url": null,
  "liveness_status": null,
  "access_token": null,
  "status": "PENDING"
}

    When a cadastral update is already in progress for the same document, the existing requisition is returned with the same shape — no second journey is opened.

    FieldTypeDescription
    workedBooleanAlways true for successful requests.
    onboarding_requisition_idIntegerIdentifier of the cadastral-update requisition.
    onboarding_linkStringLink of the hosted update pages. Send the end user to this URL.
    liveness_urlStringNot used on this flow. Comes back null.
    liveness_statusStringNot used on this flow. Comes back null.
    access_tokenStringNot used on this flow. Comes back null. Status of the update is read with the Bearer token.
    statusStringCurrent status of the update requisition. PENDING when a new one is created.

    Error Responses

    HTTP CodeError MessageDescription
    400Atualização cadastral só é permitida quando o prazo (registration_update_deadline) estiver vencido.The account has no expired registration deadline. Call the status endpoint and wait until can_start is true.
    400Já existe uma requisição de onboarding (criação de conta) em andamento para este documento.The document still has an account-opening onboarding in progress. Finish or wait for that journey before starting a cadastral update.
    400Já existe uma requisição de onboarding para este documento que não é de atualização cadastral.The document has an opening requisition that is not a cadastral update and is not in a state that allows one.
    400Company document is not a valid CPF or CNPJ.The authenticated account document is not a valid CPF or CNPJ.
    400No onboarding layout configured for type PJ_REGISTER_UPDATE.There is no active cadastral-update layout for this account type. Confirm with your account manager.
    401UnauthorizedMissing or invalid Bearer token.
    404Company not foundThe authenticated session is not linked to an account that can start a cadastral update.
    422Validation errorThe body is missing email or the value is not a valid e-mail address.

    Business Rules

    When it is allowed:

    • The authenticated account must have a registration deadline, and that deadline must already be in the past.
    • Check can_start on GET /v3/onboarding/registration-update/status before calling this endpoint.

    What is sent:

    • The body carries only email.
    • The document and the PF/PJ type are resolved from the authenticated account.

    Re-entry:

    • If a cadastral update is already open and has not reached a final decision, the existing requisition is returned instead of creating another one.
    • If the previous update was rejected, a new requisition can be created.

    After a successful start:

    • Send the end user to onboarding_link.
    • Poll GET /v3/onboarding/registration-update/status until the update is no longer IN_PROGRESS.