UNunipile
Accounts

Solve a code checkpoint

Changed on

Allows you to provide a code which will solve a checkpoint encountered during a native authentication. A checkpoint is a security step added by a provider which needs to be solved to complete the authentication. Checkpoints that require a code are 2FA (two-factor authentication) and OTP (one-time password). Depending on the way you have configured the account you are trying to authenticate, you can get your code from various ways such as a mail, a SMS or from a two-factor authentication app.

post/api/v1/accounts/checkpoint

Request

Request body

account_idstring required

A unique identifier.

codestring required

The code to solve the checkpoint. If the code is a phone number, it should be preceded by the international dialling code in brackets (e.g. (+33)0612345678 for France). If you need to switch to a different type of checkpoint, enter TRY_ANOTHER_WAY here (e.g. from In app validation to 2FA).

provider'LINKEDIN' | 'INSTAGRAM' | 'TWITTER' | 'MESSENGER' required

Response

Created. The code is valid and the authentication is completed.

object'AccountCreated' required
account_idstring required

A unique identifier.

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/already_used enum value to the response property for the response status

    • warning

      added the new errors/checkpoint_switching_not_available enum value to the response property for the response status

    • warning

      added the new errors/conflict enum value to the response property for the response status

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • warning

      added the new errors/target_audience_too_small enum value to the response property for the response status