Export a profile or case

Shares one of your approved business profiles, user profiles or user verification sessions with a Recipient right away, under a contract you name.

You don't need this endpoint for normal sharing: when you approve a record that matches a live agreement, AiPrise exports it automatically after a short settle window. Use this endpoint to share a record on demand, for example a record approved before the agreement went live.

The record goes through the same eligibility checks as an automatic export (agreement rules, verification age and consent). It skips the settle window.

The response is always 200 when the request is valid. Check export_state to see what happened:

  • READY_TO_BE_EXPORTED: a token was created and is being sent. It moves to READY_TO_BE_IMPORTED within seconds.
  • TOKEN_EXPORT_FAILED: a token was created but could not be queued. Contact AiPrise support.
  • TOKEN_NOT_CREATED: no token was created. Either no live agreement on this contract matches the record, or the record was already shared on this contract. Use List exported tokens to find an existing token.

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…
Body Params
string
enum
required

What to share. Case-insensitive.

Allowed:
string
required

The business_profile_id, user_profile_id or verification_session_id to share. It must belong to your company.

string
required

The contract (connection) with the Recipient. You must be the Donor on this contract.

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