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_IMPORTEDis 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 includesfailure.
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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Missing or invalid API key.
429Rate limit exceeded.
