ADMiT Scores API

The ADMiT Scores API is used to retrieve score information for individuals.

Before you begin:

• How to Authenticate
• What is ADMiT?
• Assessments and Scores

Endpoints

Environment	Base URL
Test	https://api.staging.principa.cloud/admit/v1
Production	https://api.principa.cloud/admit/v1

Retrieve existing Scores

POST /scores

Purpose	Fetches psychometric score information for a previously assessed individual.
Success response	200 OK - returns a ScoreResult object
Tags	Scores

Request body = 'ScoreRequest'

Field	Type	Required	Notes
countryCode	string	yes	Country where the assessment was performed (ISO-3166-1 alpha-2)
idOrPassport	string	yes	ID or passport number used in the assessment
scoreType	string	yes	Score type used in the assessment

Example request

{
  "idOrPassport": "string",
  "countryCode": "string",
  "scoreType": "string"
}

Response

ScoreResult is currently defined as an empty object in the specification; contact Principa support for the definitive shape once finalised.

Successful response example - Code 200

{
  "success": true,
  "code": "SUCCESS",
  "message": "Score retrieved successfully",
  "score": 33.20,
  "scoreType": "SCORE_DRA"
}

Unsuccessful response examples

{
  "success": false,
  "code": "INVALID",
  "message": "ID or Passport number is not valid.",
  "scoreType": "SCORE_DRA"
}

{
  "success": false,
  "code": "INSUFFICIENT_FUNDS",
  "message": "Not enough funds available"
}