Synctera offers the ability to create physical cards with custom images, such as customers’ personal photos.
GET /v0/cards/products
. Any entry in the list of card products with an image_mode
field supports custom images.
All custom card images must be in JPEG format.
image_mode
then it supports custom images. The only supported image_mode
is "REQUIRED_APPROVED_FIRST"
. In this mode card creation requests using that card product must include an image ID and the image ID included in the card creation request must refer to an image which is in the "APPROVED"
state.
"NOT_UPLOADED"
state and then transition to the "UNREVIEWED"
state and finally to either "APPROVED"
or "REJECTED"
.
Images that are "APPROVED"
maybe be updated to "REJECTED"
but not the other way around.
POST /v0/cards/images
. The request body must contain the customer ID and the ID of a card product that supports custom images.
"NOT_UPLOADED"
state with its UUID.
Content-Type
header to image/jpeg
.
In the response you should see that the image is now in the "UNREVIEWED"
state.
Once you have uploaded the image data for an image it can not be changed. If you want to upload a new image instead you must create a new image entity with a new ID. You must start the two-step process again at the first step.
GET /v0/cards/images/{image_id}
. You can also list all of a customer’s images by performing a GET /v0/cards/images?customer_id={{customer_id}}
.
To get the JPEG image data, perform a GET /v0/cards/images/{{card_image_id}}/data
.
POST /v0/cards
using the card product that supports custom images and specifying the image ID in the card_image_id
field.
GET /v0/cards/{{card_id}}
. You can also get these updated fields as soon as the card is fully created via a webhook.