Download a PDF card

Method GET {API_BASE}/v2.1/client/{key}/{crid}/card

Generate the printable card PDF for the CRID.

Authorization

Required scope client_v2

The API key is intentionally kept in the path for V2 compatibility: /v2.1/client/{key}/{crid}/... or /v2.1/user/{key}/{crid}/.... Client routes require the client_v2 scope. User routes require the user_v2 scope. Unknown, expired, revoked, malformed, or wrong-scope keys return the legacy JSON error envelope.

Parameters

Name	In	Type	Required	Constraints	Description
`key`	Path	`string`	Required		API key kept in the URL for V2 compatibility. Requires `client_v2` or `user_v2` depending on the route.
`crid`	Path	`string`	Required		Client reference ID, usually an order or campaign reference.

Responses

200 application/pdf

PDF card.

400 application/json Schema LegacyError

Invalid key, CRID, payload, message state or business precondition.

403 application/json Schema LegacyError

Key is authenticated but scope or platform constraints are invalid.

json 403

{
  "status": 1,
  "error": "forbidden"
}

forbidden

json 403

{
  "status": 1,
  "error": "forbidden"
}

invalidPlatformConstraint

json 403

{
  "status": 1,
  "error": "key_invalid"
}

502 application/json Schema LegacyError

PDF card rendering failed upstream.

json 502

{
  "status": 1,
  "error": "card_renderer_failed"
}

503 application/json Schema LegacyError

PDF card renderer is temporarily unavailable.

json 503

{
  "status": 1,
  "error": "card_renderer_unavailable"
}