Skip to main content
POST
Request Enhanced Profile

Authorizations

Authorization
string
header
required

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

Path Parameters

kyckrId
string
required

Kyckr company reference, a shared format, usable across our V2 APIs

Body

application/json
customerReference
string

Optional client reference

contactEmail
string<email>

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

Response

Created

orderId
string

The related orderId.

Example:

"12345"

correlationId
string

The related correlationId to this request, for support purposes.

customerReference
string

A customer provided reference, which appears in the order list.

timeStamp
string<date-time>

The UTC time at which the request occurred.

details
string

The response status details for the current request.

cost
object

Cost of an item

status
enum<string>
Available options:
Success,
Pending,
Failed