Retrieve an external card session
Retrieve the status of an external card session. Restricted to HIFI’s hosted session UI; not callable with a client API key.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the user.
^user_[A-Za-z0-9]+$Public ID of the external card session (prefixed with ecs_)
Response
External card session retrieved successfully.
A hosted external card collection session.
Public ID of the card session (prefixed with ecs_).
"ecs_2mNpXwZ7bV1aLcs3Kf9dQ"
Public ID of the user this session belongs to (prefixed with usr_).
"usr_3Kf9dQ2mNpXwZ7bV1aLcs"
Public ID of the associated counter party, if one was supplied or has since been created.
"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"
Hosted session URL, including a fragment-embedded session token. Only present on creation.
"https://dashboard.hifi.com/sandbox/external-card-sessions/ecs_2mNpXwZ7bV1aLcs3Kf9dQ?userId=usr_3Kf9dQ2mNpXwZ7bV1aLcs#sessionToken=..."
"jane.doe@example.com"
"https://example.com/card-onboarding/complete"
PENDING, PROCESSING, COMPLETED, EXPIRED "PENDING"
"2026-07-01T11:30:00.000Z"
"2026-07-01T10:30:00.000Z"
"2026-07-01T10:30:00.000Z"