Sign in
Card attachment

Get the attachment status

The connected user's latest attachment: pending while the user hasn't finished the link, active with card details once attached, or ineligible with a reason when the card cannot be attached (fall back to wallet funding + create_card).

get/api/v2/attach

Query parameters

user_idstring required

The connected user's id.

Response

The attachment.

object'card_attachment' required
idstring required

The attachment id.

user_idstring required
status'pending' | 'active' | 'ineligible' required

pending — the user has not finished the attach link. active — attached; create_card now mints against this card. ineligible — this card cannot be attached; fall back to wallet funding + create_card.

attach_urlstring

The hosted link the user opens to add their card. Present only on the start response.

expires_atstring date-time

When the attach link expires (48 hours). Present only on the start response.

reasonstring

Why the card cannot be attached (e.g. issuer_excluded, commercial_card). Present when status is ineligible.

messagestring

Human-readable guidance. Present when status is ineligible.

Changes