Skip to main content
This endpoint returns a digital preview of a confirmed certificate. Use the confirmation ID returned when the certificate was confirmed to fetch the viewable digital copy.

Endpoint

EnvironmentURL
ProductionGET https://api.waec.org/api/v1/external/certificate/confirmation/preview/{id}
SandboxGET https://api.sandbox.smartdocument.org/api/v1/external/certificate/confirmation/preview/{id}

Authentication

Required. Include your API Secret key in the X-DigiCert-Secret request header.
X-DigiCert-Secret: <your_api_secret_key>
Each environment uses a separate key. See Environments for details.

Path Parameters

id
string
required
The unique identifier of the confirmed certificate (for example, 48a78b36-073a-46cf-85d4-d1d4f5afb2cf).

Example Request

curl -X GET https://api.sandbox.smartdocument.org/api/v1/external/certificate/confirmation/preview/48a78b36-073a-46cf-85d4-d1d4f5afb2cf \
  -H "X-DigiCert-Secret: <your_api_secret_key>"

Response

The response returns the digital certificate content. This may be rendered as an image, PDF, or structured JSON object depending on the certificate type.
success
boolean
true when the certificate preview was retrieved successfully.
data
object
The digital certificate preview data, including the certificate image or document URL and associated metadata.

Success Response

Status: 200 OK
{
  "success": true,
  "data": {
    "id": "48a78b36-073a-46cf-85d4-d1d4f5afb2cf",
    "preview_url": "https://api.smartdocument.org/storage/certificates/48a78b36-073a-46cf-85d4-d1d4f5afb2cf/front.png",
    "candidate_number": "4251212055",
    "year": "2013",
    "country": "NG"
  }
}

Error Cases

Error CodeHTTP StatusWhen it occurs
UNAUTHORIZED401The X-DigiCert-Secret header is missing or invalid
NOT_FOUND404No confirmed certificate exists for the supplied id