API Reference/Accounts/Solve a code checkpoint

Solve a code checkpoint

POSThttps://api.postpress.ai/v1/accounts/checkpoint

Provide a code to solve a checkpoint encountered during native authentication. A checkpoint is a security step added by a provider (2FA or OTP) that must be cleared to complete the authentication. The code can come from email, SMS, or an authenticator app, depending on how the account is configured.

Authorization

X-API-KEYstringrequired
API key from your postpress dashboard. Sent as a request header.

Request body

account_idstringlength ≥ 1required
The id of the account whose checkpoint should be solved.
codestringlength ≥ 1required
The code to solve the checkpoint. If the code is a phone number, prefix it with the international dialling code in brackets (e.g. (+33)0612345678 for France). Send `TRY_ANOTHER_WAY` to switch to a different type of checkpoint (e.g. from in-app validation to 2FA).
providerstringrequired
LINKEDININSTAGRAMTWITTERMESSENGER
The provider for which the checkpoint is being solved.

Response 201 Created

On success the code was accepted and the authentication intent is complete.

objectstringAccountCreatedrequired
account_idstringlength ≥ 1required
A unique identifier for the authenticated account.

Example request

{
  "account_id": "acc_01HXYZ4QK3WJ8FN3M6QH7TZ8GR",
  "provider": "LINKEDIN",
  "code": "123456"
}

Example response

{
  "object": "AccountCreated",
  "account_id": "acc_01HXYZ4QK3WJ8FN3M6QH7TZ8GR"
}

Errors

Every error response follows the same envelope:

titlestringrequired
Short error title.
detailstringoptional
Human-readable explanation.
instancestringoptional
Request identifier for support.
typestringrequired
Error type identifier, e.g. `errors/invalid_checkpoint_solution`.
statusnumberrequired
HTTP status code.
400 Bad Request8 types

The request payload is invalid or missing required fields.

  • errors/invalid_parameters - One or more request parameters are invalid or missing.
  • errors/missing_parameters - One or more request parameters are missing.
  • errors/invalid_request - One or a combination of request parameters are invalid.
  • errors/malformed_request - The given request has been rejected by the provider.
  • errors/content_too_large - The request payload is too large for the provider.
  • errors/too_many_characters - The provided content exceeds the character limit.
  • errors/unescaped_characters - The request path contains unescaped characters.
  • errors/limit_too_high - Pagination limit too high. See API reference for details.
401 Unauthorized1 types

The checkpoint code was rejected.

  • errors/invalid_checkpoint_solution - The checkpoint resolution did not pass successfully. Please retry.
403 Forbidden9 types

Authenticated but the account is restricted or the action is not allowed.

  • errors/account_restricted - The account has been restricted by the provider.
  • errors/account_mismatch - Credentials don't match the requested account.
  • errors/insufficient_permissions - The account lacks the required permissions.
  • errors/session_mismatch - The session does not match the current account.
  • errors/feature_not_subscribed - The required feature is not part of your subscription.
  • errors/subscription_required - A subscription is required to use this feature.
  • errors/unknown_authentication_context - Unknown authentication context.
  • errors/action_required - The provider requires an additional action.
  • errors/resource_access_restricted - Access to this resource is restricted.
407 Proxy Authentication Required1 types

The proxy in use is rejecting the connection.

  • errors/proxy_auth_error - The proxy in use is not working. Please try again.
408 Request Timeout1 types

The provider did not respond in time.

  • errors/request_timeout - Communication with the provider has timed out. Please retry.
409 Conflict2 types

The current task conflicts with another in-flight operation.

  • errors/operation_canceled - The current task was canceled by a subsequent one.
  • errors/already_exists - An equivalent account already exists.
500 Internal Server Error3 types

Something unexpected went wrong on the server side.

  • errors/unexpected_error - Something went wrong.
  • errors/provider_error - The provider is experiencing operational problems.
  • errors/authentication_intent_error - The current authentication intent was killed after failure. Restart from the beginning.
502 Bad Gateway1 types

The proxy in use is rejecting the connection or returned an invalid response.

  • errors/proxy_error - The proxy in use is not working. Please try again.
503 Service Unavailable5 types

The service is temporarily unavailable; please retry shortly.

  • errors/no_client_session - No client session is currently running.
  • errors/no_channel - No channel to client session.
  • errors/no_handler - Handler missing for that request.
  • errors/network_down - Network is down on the server side. Retry shortly.
  • errors/service_unavailable - Service temporarily unavailable. Retry later.
504 Gateway Timeout1 types

The upstream provider did not respond in time.

  • errors/request_timeout - Request timed out. Retry, and contact support if it persists.
Updated May 2026