Skip to main content
POST
/
smart-match
Initiate Smart Matches
curl --request POST \
  --url https://api.ever.day/smart-match \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "publicIdentifer": "abc123",
  "skillsetIds": [
    "skillset1",
    "skillset2"
  ]
}
'
{
  "message": "Smart match initiated successfully."
}

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:
["skillset1", "skillset2"]

Response

Smart match process initiated successfully.

​
message
string

Confirmation message.

Example:

"Smart match initiated successfully."