API reference › Service setup › Certifications

Create new certifications

POST /v1/certifications

Scope
settings_service_setup:write
Roles
admin, scheduler

Create one or more certifications with optional metadata.

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[].label requiredstring

Example New Certification.

name[].isCustomboolean

Example true.

requirement requiredstring

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

levelinteger or null

Position within the certification body. Defaults to the next free level.

min 1. Example 1.

expirationRequiredboolean

Example true.

uploadRequiredboolean

Example true.

certificationBodyobject or null

An existing body by id, or a new one by label.

certificationBody.idinteger or null

Example 3.

certificationBody.labelstring

Example CI / CT Basic.

certificationBody.isCustomboolean

Example false.

serviceType requiredobject
serviceType.idinteger

Example 1.

serviceType.labelstring

Example ASL.

serviceProviderType requiredobject
serviceProviderType.idinteger

Example 2.

serviceProviderType.labelstring

Example Typist.

Example

JSON
{
  "name": [
    {
      "label": "New Certification",
      "isCustom": true
    }
  ],
  "requirement": "preferred",
  "level": 1,
  "expirationRequired": true,
  "uploadRequired": true,
  "certificationBody": {
    "id": 3,
    "label": "CI / CT Basic",
    "isCustom": false
  },
  "serviceType": {
    "id": 1,
    "label": "ASL"
  },
  "serviceProviderType": {
    "id": 2,
    "label": "Typist"
  }
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/certifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":[{"label":"New Certification","isCustom":true}],"requirement":"preferred","level":1,"expirationRequired":true,"uploadRequired":true,"certificationBody":{"id":3,"label":"CI / CT Basic","isCustom":false},"serviceType":{"id":1,"label":"ASL"},"serviceProviderType":{"id":2,"label":"Typist"}}'

Try it

Responses

201 Certifications created successfully

Certifications created successfully

JSON
{
  "success": true,
  "message": "Certifications created!",
  "data": [
    {
      "id": 11,
      "name": "New Certification",
      "isCustom": true
    },
    {
      "id": 12,
      "name": "Another One",
      "isCustom": true
    }
  ]
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Certifications created!.

dataarray of object
data[].idinteger

Example 11.

data[].namestring

Example New Certification.

data[].isCustomboolean

Example true.

400 Bad request

Validation failed

JSON
{
  "success": false,
  "message": "The name field is required."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The name field is required..

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 .

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

Server error

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

Example false.

messagestring

Example Something went wrong!.