Skip to main content
POST
Request AFT enrollment for a card

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Platform request to enable one direction on one user+card pair.

The card is already stored (collected via the hosted card-connect flow, so PAN / CVV never reach our API). Direction is fixed by the endpoint path (/enrollments/aft vs /enrollments/oct) — it is not part of the request body.

user_id
string<uuid>
required
card_id
string<uuid>
required

UUID of the stored card to enroll

ip_address
string
required

End-user IP at the time of enrollment

Required string length: 3 - 45

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.