Skip to main content
POST
/
api
/
v1
/
credentials
Create Credential
curl --request POST \
  --url https://api.example.com/api/v1/credentials \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "expiry_date": "<string>",
  "issuing_body": "<string>",
  "state": "<string>",
  "license_number": "<string>",
  "issue_date": "<string>",
  "s3_key": "<string>",
  "notes": "<string>"
}
'

Request Body

type
string
required
Credential type: bls, acls, pals, license, certification, or other.
name
string
required
Credential name (max 200 chars).
expiry_date
string
required
Expiration date (YYYY-MM-DD).
issuing_body
string
Issuing organization (max 200 chars).
state
string
2-letter state code (for state licenses).
license_number
string
License or certification number (max 100 chars).
issue_date
string
Date issued (YYYY-MM-DD).
s3_key
string
S3 key of an uploaded document scan.
notes
string
Additional notes (max 1000 chars).

Response

Returns the created credential with status 201.

Errors

StatusCause
400Invalid type, missing required fields, invalid state