Generate-url

post

https://staging.cypherface.com/api/img/generate-url/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

curl --request POST \
     --url https://staging.cypherface.com/api/img/generate-url/ \
     --header 'accept: application/json' \
     --header 'authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiNjdjNmU3OGJjMTA4MDNmMGZkMDM1NDNkIiwieEFwaUtleSI6IjA0Zjc3YjQ3LWIyYWUtNDNkNy1hODg2LTBiOTI1OTI2YzcyMyIsInR5cGUiOiJtZXJjaGFudFVzZXIiLCJpYXQiOjE3NTE0NjEyODIsImV4cCI6MTc1MTYzNDA4Mn0.KJvgR5DikTZZjGs6ZdFhEWTfriuz72zYkYdraPWHjv8' \
     --header 'content-type: application/json' \
     --data '
     {
	"userId": "1234567890"
	"imageKey": "image.jpg",
	"contentType": "image/jpeg",
	"type": "card"
}
'

Body Params

userId

string

Defaults to 1234567890

imageKey

string

required

Defaults to image.jpg

The imageKey represents the exact file name of the image that you will upload using the generated upload link. It is crucial that the uploaded image file name matches the provided imageKey exactly. If the file name and imageKey do not match, the image will not be stored properly, and you will not be able to extract or access the document data through our system. Please ensure consistency when naming and uploading the file.

contentType

string

required

Defaults to image/jpeg

type

string

enum

required

Defaults to card

Allowed:

Headers

authorization

string

required

Defaults to eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiNjdjNmU3OGJjMTA4MDNmMGZkMDM1NDNkIiwieEFwaUtleSI6IjA0Zjc3YjQ3LWIyYWUtNDNkNy1hODg2LTBiOTI1OTI2YzcyMyIsInR5cGUiOiJtZXJjaGFudFVzZXIiLCJpYXQiOjE3NTE0NjEyODIsImV4cCI6MTc1MTYzNDA4Mn0.KJvgR5DikTZZjGs6ZdFhEWTfriuz72zYkYdraPWHjv8

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400