API Reference
Create Unipile AccountDashboardWebsite

Solve a code checkpoint

post
https://{subdomain}.unipile.com:{port}/api/v1/accounts/checkpoint

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.

Body Params
string
required
length ≥ 1

A unique identifier.

string
required
length ≥ 1

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).

string
enum
required
Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago