Sign in
latestOpenAPI 3.1.02026-08-15190998700.4 KB

c0201d849baf

cardTokenization

Extract Card From Image

Extract the card details from a photo of a physical card and tokenize them.

This allows a customer to take a photo of their credit/debit card and have the card details auto-populated during checkout instead of typing them in manually. The card is extracted and stored as a token in Coinflow's PCI-compliant vault, and the resulting token is returned so it can be used in the cards endpoint.

In order to gain access to this endpoint your company must have PCI-DSS certification, and provide that to your Coinflow Integrations Representative.

post/tokenize/extract-card

Headers

Authorizationstring required

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request body

imagestring

A base64-encoded image of the physical card to extract details from.

Note: This is only for documentation purposes, this endpoint returns an HTTP redirect where the card image should be sent.

mimeTypestring

The MIME type of the provided image. Defaults to image/jpeg.

Note: This is only for documentation purposes, this endpoint returns an HTTP redirect where the card image should be sent.

Response

Ok

tokenstring required

The token representing the extracted card. Use this token in the cards endpoint to complete the checkout.

firstSixstring required

The first six digits of the extracted card number.

lastFourstring required

The last four digits of the extracted card number.

expirationMonthstring nullable required

The extracted card expiration month, if available.

expirationYearstring nullable required

The extracted card expiration year, if available.

cvvCapturedboolean required

Whether a CVV/CVC was captured from the image and stored with the token.

cvvHashstring nullable required

SHA-256 hex hash of the captured CVV/CVC. Compare against the hash of the CVV you expect to verify the correct value was extracted, without handling the raw CVV. Null when no CVV was captured.