Import a token

Imports a token shared with you. AiPrise creates a new profile or session in your account from the shared data and runs the template set on your agreement.

Use this when your agreement's import mode is manual. With automatic import, AiPrise imports tokens for you and you only need the webhooks.

An import runs once:

  • Only a token in READY_TO_BE_IMPORTED is imported. A token in any other state is returned as it is, and nothing runs.
  • A failed import is not retried. The token stays in IMPORT_FAILED, and the response includes failure.

After a successful import, token.entity_id_as_per_recipient is your new business_profile_id, user_profile_id or verification_session_id. Read the record with the standard Get Business Profile, Get User Profile or Get verification result APIs.

Requires your API key, or a Dashboard user with the case_management:write permission. Limited to 60 requests per minute.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the token, from a webhook, the token list or the export response.

Responses

401

Missing or invalid API key.

429

Rate limit exceeded.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json