DKBSignDocs

API reference

POSTRequires Bearer token

Renew a certificate

/api/v1/companies/{company}/certificates/{certificate}/renew

Company-admin. Certificate must not be revoked and must not already have a pending request (409 CERTIFICATE_REVOKED / REQUEST_ALREADY_PENDING).

Path parameters

FieldTypeDescription
company
Required
stringPath parameter company.
certificate
Required
stringPath parameter certificate.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
uid
Required
stringCertificate UID / enrollment identifier.
e.g. "user.jane"
common_name
Required
stringX.509 common name.
e.g. "Jane Doe"
country
Required
stringISO 3166-1 alpha-2 country.
e.g. "CI"
enrollment_username
Required
stringEnrollment username issued with the certificate.
e.g. "jane.doe"
enrollment_code
Required
stringEnrollment code issued with the certificate.
e.g. "ENROLL-EXAMPLE-CODE"
key_algorithm
stringRSA_2048 or RSA_4096.
e.g. "RSA_2048"
email_address
stringEmail embedded in the certificate.
e.g. "jane@acme.test"
title
stringJob title.
e.g. "CFO"
organizational_unit
stringOrganizational unit.
e.g. "Finance"
organization
stringOrganization.
e.g. "ACME"
state
stringState or region.
e.g. "Abidjan"
telephone_number
stringTelephone number.
e.g. "+2250700000001"
validity_days
integerValidity in days (1–3650).
e.g. 365

Responses

StatusMeaning
200Renewal requested
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/v1/companies/company/certificates/certificate/renew' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"uid":"user.jane","common_name":"Jane Doe","country":"CI","enrollment_username":"jane.doe","enrollment_code":"ENROLL-EXAMPLE-CODE","key_algorithm":"RSA_2048","email_address":"jane@acme.test","title":"CFO","organizational_unit":"Finance","organization":"ACME","state":"Abidjan","telephone_number":"+2250700000001","validity_days":365}'

Response 200

json
{
  "status": "success",
  "message": "Renewal requested",
  "data": {
    "id": 5,
    "status": "pending"
  }
}