Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
applicationId
string
required
Minimum string length: 1
question
string
required
Required string length: 1 - 2000
answer
string
required
Required string length: 1 - 6000
source
enum<string>
required
Available options:
manual,
application,
ai-assisted
scope
enum<string>
required
Available options:
reusable,
employer,
application
factIds
string[]
required
Maximum array length: 10
Minimum string length: 1
storyIds
string[]
required
Maximum array length: 10
Minimum string length: 1
expectedEvidence
object[]
required
Maximum array length: 320
reviewed
any
required
noEmployerWording
boolean
required
id
string
Minimum string length: 1
expectedRevision
integer
Required range: -9007199254740991 < x <= 9007199254740991

Response

OK

id
string
required
userId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
question
string
required
answer
string
required
source
enum<string>
required
Available options:
manual,
application,
ai-assisted
scope
enum<string>
required
Available options:
reusable,
employer,
application
employer
string
required
applicationId
string | null
required
sourceApplicationId
string | null
required
factIds
string[]
required
storyIds
string[]
required
evidence
object[]
required
reviewedAt
string<date-time>
required
revision
integer
required
Required range: -2147483648 <= x <= 2147483647
duplicateKey
string
required