Skip to content
These docs describe staging.zkao.io and the @zksecurity/zkao-cli@next release. For production, see docs.zkao.io.

Add an advisory contact

View .md
POST
/projects/{projectId}/advisory-contacts
curl --request POST \
--url https://zkao.io/api/v1/projects/example/advisory-contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "example", "organization": "example", "tier": "EMBARGO", "software": [ { "owner": "example", "name": "example" } ], "name": "example", "title": "example", "notes": "example", "tags": [ "example" ] }'

Requires scope: contacts:write. Puts one address on the programme’s contact list.

software says which of the project’s repositories this contact runs, and is required. It is what every notice is matched on: a contact who runs nothing is told nothing.

The contact starts PENDING_VERIFICATION, and an unconfirmed address receives nothing embargoed. The confirmation mail is sent from the app, not by this call, so nothing is emailed to the address you send here.

There is no endpoint that reads the contact list back. It is other people’s work addresses and the record of who hears about a vulnerability early.

projectId
required
string
Media typeapplication/json
object
email
required
string
organization
required

The organisation this contact speaks for.

string
tier
required

How early this contact is told. EMBARGO hears first and alone, DOWNSTREAM joins once a patch exists, ANNOUNCE learns at public disclosure.

string
Allowed values: EMBARGO DOWNSTREAM ANNOUNCE
software
required

The repositories this contact runs. At least one.

Array<object>
>= 1 items
object
owner
required
string
name
required
string
name
string | null
title
string | null
notes
string | null
tags
Array<string>

Created

Media typeapplication/json
object
contact
required
object
id
required
string
email
required
string
organization
required
string
tier
required
string
status
required

PENDING_VERIFICATION until the contact confirms the address. An unconfirmed address receives nothing embargoed.

string
software
required

The software this contact runs, which notices are matched on.

Array<object>
object
owner
required
string
name
required
string
createdAt
required
string format: date-time
Examplegenerated
{
"contact": {
"id": "example",
"email": "example",
"organization": "example",
"tier": "example",
"status": "example",
"software": [
{
"owner": "example",
"name": "example"
}
],
"createdAt": "2026-04-15T12:00:00Z"
}
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Missing, malformed, expired, or revoked token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

The token lacks the required scope

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Resource not in this token’s project or repo allowlist

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

That address is already on the programme’s contact list.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}