post
https://api.sandbox.astrada.co/enrollment-links
Creates an enrollment link for one of your subaccounts. The link opens a page on
Astrada's SDK host where the person who has it enrolls their own cards into that
subaccount.
- A personal link (
kind: cardholder) is for one employee. It allows up to 5 session
starts and is used up by the first session that completes something. - A team link (
kind: team) is for sharing. Each session start counts as a use, up to
maxUses.
The response's url carries the link's secret after #. This response is the only
one that returns it, and it is sent with Cache-Control: no-store. Astrada stores only
a hash of the secret. In sandbox the url starts with
https://sdk.sandbox.astrada.co/unified/v2/enroll.html#.
Requires subaccounts:write.
Refusals carry a code:
404SUBACCOUNT_NOT_FOUND:subaccountIdis not one of your subaccounts.409ENROLLMENT_LINKS_NOT_ENABLED: enrollment links are not enabled for your
account.409CARD_ENROLLMENT_OFF: card enrollment is off for the subaccount (its
enrollmentPolicy.cardEnrollmentisfalse). The hosted page offers card enrollment
only, so a link would have nothing to enroll. This check runs before the daily limit
is counted, so a refused request does not use it up.400LINK_NAME_NOT_ALLOWED:organizationNameorplatformNameis a
well-known brand name, such as a card network or a large bank, matched ignoring case,
accents and punctuation. Astrada and Plaid are also refused inside a longer name.429RATE_LIMITED: your account has created 2,000 links today (UTC), team links
made withPOST /subaccounts/{subaccountId}/team-linkincluded.
A link made before card enrollment was turned off starts no session while card
enrollment stays off: POST /enrollment-link-sessions/preview and
POST /enrollment-link-sessions answer 409 CARD_ENROLLMENT_OFF, and no start is
counted.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
