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

FieldTypeDescription
name requiredarray of object
name[].idinteger
name[].label requiredstring

Example DOJ Clearance.

clearanceBody requiredobject
clearanceBody.idinteger
clearanceBody.labelstring

Example Internal Authority.

requirementstring

One of: mandatory, preferred, optional. Example preferred.

expirationRequiredboolean

Example true.

uploadRequiredboolean

Example true.

tenant_idstring or null

Example demotenant.

Example

JSON
{
  "name": [
    {
      "id": null,
      "label": "DOJ Clearance"
    }
  ],
  "clearanceBody": {
    "id": null,
    "label": "Internal Authority"
  },
  "requirement": "preferred",
  "expirationRequired": true,
  "uploadRequired": true,
  "tenant_id": "demotenant"
}

Example request

Shell
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.

JSON
{
  "success": true,
  "message": "Clearances created!",
  "data": [
    {
      "id": 5,
      "name": "DOJ Clearance",
      "isCustom": true
    },
    {
      "id": 6,
      "name": "asdsads",
      "isCustom": true
    }
  ]
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Clearances created!.

dataarray of object
data[].idinteger

Example 5.

data[].namestring

Example DOJ Clearance.

data[].isCustomboolean

Example true.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_service_setup:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields..

errorsobject
errors.namearray of string
errors.clearanceBodyarray of string
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error.

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.