GEgetpliant
Access Links

Create an access link

Changed on

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.

post/access-links

Request

Request body

organizationIdstring uuid required

Organization the card belongs to.

Example request

{
  "grants": [
    {
      "linkType": "CARD_WIDGET"
    }
  ]
}

Response

Ok

accessLinkIdstring uuid required

Identifier of the access link.

accessLinkstring uri nullable

The shareable URL. Returned only when you create the link. You cannot fetch it again.

issuedBystring uuid required

Who created the link.

organizationIdstring uuid required
createdAtstring date-time required
revokedAtstring date-time nullable

Set when the link has been revoked.

Example response

{
  "grants": [
    {
      "linkType": "CARD_WIDGET",
      "resourceType": "card"
    }
  ]
}

Changes