Create an access link

post

https://partner-api.getpliant.com/api/access-links

Creates a shareable access link for one card. Anyone with the link can
use a limited card widget — card details, add to wallet, and the
cardholder's personal details — without a Pliant account. Treat the
link as sensitive.

Save accessLink from the response. You receive it only once. Creating
another link for a card that already has an active link replaces that
previous link; the old URL stops working.

The card must belong to organizationId, must not be expired or
terminated, and the card product must allow access links. Locked cards
are allowed. Expiry and how many times the link can be opened are set
by Pliant.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Ok

400Bad Request. Typical errorCode values: NOT_FOUND — the card is missing or is not in this organization CARD_NOT_MINTABLE — the card is expired or terminated ACCESS_LINK_NOT_ENABLED — this card product does not allow access links ONLY_ONE_CARD — the request includes more than one card

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

409Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.

422Unprocessable Content. The request could not be completed due to contents of the request. The syntax of the request content was correct.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.