Solve Checkpoint Endpoint

Solve a 2FA/OTP checkpoint to complete account connection.

POST /api/v1/connected-accounts/checkpoint

Solve Checkpoint Endpoint

cURL

curl --request POST \
  --url https://api.example.com/api/v1/connected-accounts/checkpoint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkpoint_token": "<string>",
  "code": "<string>"
}
'

200

{
  "success": true,
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "<string>",
    "provider_account_id": "<string>",
    "status": "connected",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "profile_url": "<string>",
    "is_default": false,
    "daily_connection_limit": 25,
    "daily_message_limit": 100,
    "warmup_days": 14,
    "connection_country": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to solve a 2FA/OTP checkpoint.

checkpoint_token · string · required

code · string · required

Response

200

application/json

Successful Response

Response from solving a checkpoint.

success · boolean · required

account · ConnectedAccountResponse · object

Response model for a connected account.

Show child attributes