API reference › Providers

Delete a qualification record

DELETE /v1/provider/qualification/{qualificationType}/{id}

Scope
providers:edit
Roles
admin, scheduler

Deletes an entire qualification (either clearance or certification), including associated document(s), based on qualification type and ID.

Parameters

Path parameters

NameTypeDescription
qualificationType requiredstring

Type of qualification (e.g., 'clearances' or 'certifications')

One of: clearances, certifications. Example certifications.

id requiredstring

ID of the qualification record to delete

Example 456.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/provider/qualification/{qualificationType}/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Qualification deleted successfully

Qualification deleted successfully

JSON
{
  "message": "certifications is deleted"
}
Response fields (1)
FieldTypeDescription
messagestring

Example certifications is deleted.

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 'providers:edit' 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 'providers:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Qualification record not found

JSON
{
  "message": "Qualification not found"
}
Response fields (1)
FieldTypeDescription
messagestring

Example Qualification not found.

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
{
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (1)
FieldTypeDescription
messagestring

Example An unexpected error occurred. Please try again later..