Peleza β€” Trust built on data
Digital Credentials
On this page

Get Results

Retrieve verification payloads after status is Complete. While Processing or Pending Consent, returns processing metadata with results_count: 0. Does not charge the wallet.

Request

GET/api/v1/credentials/results/{searchId}
{{baseUrl}}/api/v1/credentials/results/{searchId}
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

Response

200 OKSample dataExample response
{
  "success": true,
  "response_code": 200,
  "message": "Search results retrieved successfully",
  "data": {
    "search_id": 125,
    "status": "Complete",
    "results_count": 1,
    "results": [
      {
        "student": {
          "first_name": "James",
          "middle_name": "Otieno",
          "last_name": "Kamau",
          "full_name": "James Otieno Kamau",
          "student_number": "F16/084726/2016"
        },
        "issuer": {
          "name": "University of Nairobi",
          "country": "Kenya",
          "type": "University"
        },
        "programs": [
          { "name": "Bachelor of Commerce (Finance)", "code": "BSC-FIN-2016", "level": "Undergraduate" }
        ],
        "academic_info": {
          "certificate_type": "Transcript",
          "graduation_date": "2020-11-27",
          "gpa": "3.42",
          "class_of_degree": "Second Class Honours (Upper Division)",
          "status": "final"
        },
        "verification_status": {
          "verified": true,
          "verification_method": "Digital Credentials API"
        }
      }
    ]
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request succeeded
response_codenumberApplication response code (typically mirrors HTTP)
messagestringHuman-readable status message
dataobjectPayload for the verified resource
request_idstringUUID for support and audit trails

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.