For developers

Integrate verification into your admission workflow

The Epinmart API gives your engineering team one integration to verify O'level results against every supported examination body.

Request API access

Note: the examples below are illustrative, to show the shape of an integration. Exact endpoints, fields, and authentication are shared in the developer documentation provided when you request access.

How an integration works

  1. 1

    Get credentials

    We issue your institution an API key after onboarding.

  2. 2

    Call one endpoint

    Send candidate details to the verification endpoint over HTTPS.

  3. 3

    Handle the response

    Store the normalised, verified result against the applicant record.

Authentication

Requests are authenticated with an API key issued to your institution, sent as a bearer token over HTTPS. Keys are scoped to your account and can be rotated on request.

Authorization: Bearer <YOUR_API_KEY>

A sample verification call

Request

curl https://api.epinmart.com/v1/verifications \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "exam_body": "WAEC",
    "exam_type": "WASSCE",
    "exam_number": "4250101001",
    "exam_year": 2023,
    "candidate_name": "Adaeze Okoro"
  }'

Response

{
  "verification_id": "ver_8f3a91c2",
  "status": "verified",
  "exam_body": "WAEC",
  "exam_number": "4250101001",
  "exam_year": 2023,
  "candidate_name": "Adaeze Okoro",
  "results": [
    { "subject": "English Language", "grade": "B3" },
    { "subject": "Mathematics", "grade": "A1" },
    { "subject": "Biology", "grade": "C4" }
  ],
  "verified_at": "2023-09-14T10:22:05Z"
}

Ready to build?

Request access and we'll share the full developer documentation and credentials.

Request API access