Digital Credentials Search

Search academic credentials. May return an immediate match or a Processing response with search_id when consent / async verification is required.

Request

POST/api/v1/digital-credentials/search

{{baseUrl}}/api/v1/digital-credentials/search

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
full_name	string	Student full name	required
country	string	Country of study (e.g. Kenya, Uganda)	required
type	string	Transcript or Certificate	required
student_email	string	Student email for consent outreach	required
university	string	Institution name	optional
course	string	Course / programme	optional
graduation_year	string	Graduation year	optional
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional
consent_provided	boolean	Whether student consent was already collected	optional

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Search submitted",
  "data": {
    "search_id": "dc_abc123",
    "status": "Processing"
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID 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.