Create

Issue a credential (REST style). Provide the recipient with name +
email, and the credential with credential_uuid or
credential_identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 2
string
required
string
  • required when credential_identifier is not present
string
  • required when credential_uuid is not present
boolean
Defaults to false
  • optional
  • default is false
  • accepted input are true, false, 1, 0, "1", "0"
date
  • optional
  • default is null
  • only yyyy-mm-dd format is allowed
date
  • optional
  • default is null
  • only yyyy-mm-dd format is allowed
  • must be today or earlier (a future date is rejected)
boolean
Defaults to true
  • optional
  • default is true
  • accepted input are true, false, 1, 0, "1", "0"
boolean
Defaults to false
  • optional
  • default is false
  • when true, a new credential is issued even if the recipient already
    has this credential (a duplicate). Duplication wins when both
    allow_duplication and update_if_exists are set
  • accepted input are true, false, 1, 0, "1", "0"
boolean
Defaults to false
  • optional
  • default is false
  • when true, if the recipient already has this credential it is updated
    instead of being left unchanged. The response updated field reflects
    whether this request actually mutated the credential
  • accepted input are true, false, 1, 0, "1", "0"
custom_fields
object
  • optional
  • custom field values to attach to the recipient and/or the issued
    credential. Each key must match a custom field configured for your
    account; unknown keys are rejected
uri
length ≤ 2048
  • optional
  • external https url to a certificate PDF. When set, it is used as the
    certificate for this issuance instead of the badge's design template
    (the external PDF takes precedence)
  • must be https and reachable; the file is downloaded and stored intact,
    and a preview image + thumbnail are derived from its first page
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json