Skip to main content
POST
Create enrollment

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Idempotency-Key
string
required

Unique key for safely retrying this request. Up to 255 characters; we recommend a UUIDv4. The first request executes and its response is cached; subsequent requests with the same key replay the cached response (24h retention).

Required string length: 1 - 255

Body

How the card is enrolled. The request shape depends on source.

Enroll an existing card

source
string
required
Allowed value: "REAP_CARD"
cardId
string<uuid>
required

Card identifier to enroll

Response

Created enrollment. The response shape depends on source.

Enrollment created from an existing card

id
string
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
REQUIRES_ACTION,
ACTIVE,
FAILED,
EXPIRED,
REVOKED
Example:

"REQUIRES_ACTION"

source
string
required
Allowed value: "REAP_CARD"
owner
Reap user · object
required

Cardholder that owns this enrollment