Skip to main content
POST
Create a reveal session
Show your user their card’s number, expiry and CVC without your server ever holding them. Create a session when your user asks, then open url in their browser, in a frame or a new window. Each session shows the card once and expires after five minutes. Show your user their card walks through it.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Path Parameters

card_id
string
required

Body

application/json
expires_in
integer
default:300

Seconds the link works. The session shows the card once within that window.

Required range: 60 <= x <= 900

Response

The session.

object
enum<string>
required
Available options:
card_reveal_session
id
string
required
Example:

"crs_9c590edd43234d1ce1f4c22f"

card_id
string
required
Example:

"card_542fdd3856629b3cc74019cc"

url
string<uri>
required

Agentcard's card page for this session. Open it in your user's browser.

Example:

"https://reveal.agentcard.sh/r/crs_9c590edd43234d1ce1f4c22f.5d3guB0evMZaTFHkHovUlVwF9kHWfW0wuJPfRzea26c"

expires_at
string<date-time>
required
test_mode
boolean
required

True for a test card. The page says so.