Skip to main content
POST
Create a key for a customer

Authorizations

Authorization
string
header
required

An API key created in the PartFinder console at https://console.partfinder.dev, or a customer key created with POST /v1/keys. Send as Authorization: Bearer <key>. Revocation takes effect within approximately one minute.

Body

application/json
company
string

Your customer's company name. Required for a new end customer; it becomes the requester company of the requests for quote this key sends when they name none. Leave it out when end_customer_id is set.

Required string length: 1 - 200
end_customer_id
string<uuid>

Add a key for an end customer you already created, for example to replace a key: create the new one, move your customer over to it, then revoke the old one. Its data stays with the end customer.

name
string

A name for the key, unique in your organization, including revoked keys. One is made up when absent.

Required string length: 1 - 100

Response

Created. Store secret now: it is not shown again.

as_of
string<date-time>
required

ISO 8601. How current the data in this response is.

summary
string
required

Plain language an agent can relay without re-deriving it.

notice
string
required

Informational-use notice. Always present.

key
object
required
secret
string
required

The key itself, shown only in this response: give it to your customer's integration now. It cannot be shown again.