Skip to main content
POST
Initiate Smart Matches

Authorizations

x-api-key
string
header
required

Include your API key in the x-api-key header to authenticate requests. Each organisation is provided with a unique API key. If your key is lost or compromised, contact support to request a new one.

Body

application/json
publicIdentifer
string

The external unique identifier.

Example:

"abc123"

skillsetIds
string[]

A list of skillset IDs to match against.

Example:

Response

Smart match process initiated successfully.

message
string

Confirmation message.

Example:

"Smart match initiated successfully."