API ReferenceCard Tokenization

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.

Authentication

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

Request

This endpoint expects an object.
imagestringOptional

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.

mimeTypestringOptional

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
The token representing the extracted card. Use this token in the cards endpoint to complete the checkout.
firstSixstring
The first six digits of the extracted card number.
lastFourstring
The last four digits of the extracted card number.
expirationMonthstring or null
The extracted card expiration month, if available.
expirationYearstring or null
The extracted card expiration year, if available.
cvvCapturedboolean

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