API reference › Service setup › Clearances
Create new clearances
POST /v1/clearances
- Scope
settings_service_setup:write- Roles
- admin, scheduler
Create one or more clearances with optional custom names and body.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name required | array of object | |
name[].id | integer | |
name[].label required | string | Example |
clearanceBody required | object | |
clearanceBody.id | integer | |
clearanceBody.label | string | Example |
requirement | string | One of: |
expirationRequired | boolean | Example |
uploadRequired | boolean | Example |
tenant_id | string or null | Example |
Example
{
"name": [
{
"id": null,
"label": "DOJ Clearance"
}
],
"clearanceBody": {
"id": null,
"label": "Internal Authority"
},
"requirement": "preferred",
"expirationRequired": true,
"uploadRequired": true,
"tenant_id": "demotenant"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/clearances" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":[{"id":null,"label":"DOJ Clearance"}],"clearanceBody":{"id":null,"label":"Internal Authority"},"requirement":"preferred","expirationRequired":true,"uploadRequired":true,"tenant_id":"demotenant"}'Try it
Responses
201 Clearance(s) created successfully
Clearance(s) created successfully.
{
"success": true,
"message": "Clearances created!",
"data": [
{
"id": 5,
"name": "DOJ Clearance",
"isCustom": true
},
{
"id": 6,
"name": "asdsads",
"isCustom": true
}
]
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Example |
data[].isCustom | boolean | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_service_setup:write' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation failed.
{
"success": false,
"message": "Unable to save. Please check the highlighted fields.",
"errors": {
"name": [
"Clearance name is required."
],
"clearanceBody": [
"Clearance Body name is already taken."
]
}
}Response fields (5)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.name | array of string | |
errors.clearanceBody | array of string |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |