Skip to main content
POST
/
orders
Create Order
curl --request POST \
  --url https://api.kyckr.com/v2/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kyckrId": "<string>",
  "productId": "<string>",
  "schemaVersion": "2.0",
  "customerReference": "<string>",
  "contactEmail": "jsmith@example.com"
}
'
"<unknown>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
kyckrId
string
​
productId
string
​
schemaVersion
string

🚧 Preview — planned, not yet available in production. Optional schema version for the product response payload. Defaults to the latest available version when omitted. Server supports the current major version (N) and the previous one (N-1); requests for older versions return 410 Gone with a list of supported versions in the response body. Responses for deprecated versions include Sunset (RFC 8594) and Deprecation (RFC 9745) headers.

Example:

"2.0"

​
customerReference
string
​
contactEmail
string<email>

An email address that can be contacted in case of issues with the order

Response

Created

The response is of type any.