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

Query Parameters

extend
string

Profile extension type to include in the order result. shareholdingSummary populates additionalInformation.shareholdingSummary, which is described in the response of GET /companies/{kyckrId}/enhanced. Read the result from GET /orders/{orderId}/download?format=json at additionalInformation.shareholdingSummary. shareholdingSummary alone uses a threshold of 25. shareholdingSummary:<n> uses <n>, which is 5, 10, 15, 20 or 25, for example extend=shareholdingSummary:10. Names are case-insensitive. Each request carries one threshold. The option is read from the query string. Other values are ignored.

An unsupported threshold, such as shareholdingSummary:30, returns HTTP 400 with the detail shareholdingSummary threshold must be one of 5, 10, 15, 20, 25. More than one shareholdingSummary entry returns HTTP 400 with the detail shareholdingSummary may only be requested once. A 400 does not place an order and does not incur a charge.

Example:

"shareholdingSummary:10"

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

Accepted: enhanced profile order created, profile not yet ready

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

data
object