Introduction

The Identification API is a REST-based interface to our identity verification services. Before making API calls, you will need to contact our Developer Relations group to receive credentials and get your server IP addresses white-listed.

schema

Here we discuss the general format for endpoints, status codes, and content.

URL

The URL schema for the API is:

https://{domain}/identification/api/{version}/{resource}

The meaning of each token is:

Token Description
{domain} You will receive the domain name at the time you receive your credentials.
{version} The version you want to communicate with (ex. v1 or v2).
{resource} The resource you want to perform operations on.

Example
The endpoint https://qaservices.goldstartrust.com/identification/api/v1/ops/ping will return the current date & time from the server.

HTTP Headers

Header Description
X-ApiKey You will receive your api key from Goldstar Trust. All api calls will require this header.

json

All data is sent and received as JSON.

operations

Because the Identification API is REST-based, we use HTTP verbs for all operations.

Status Codes

Response will have one of the following status codes. 

Verb Description
GET Select one or more resources and respond with results in the body.
POST Create or invoke behavior on a resource and respond with results in the body.
PUT Update an existing resource and respond with results in the body.
DELETE Delete an existing resource and respond with nothing in the body.
CodeDescription
200 Success - requested resource is in the response
201 Success - the newly created resource is in the response
204 Success - but no content to return
400 Bad - could not be understood bythe server
401 Unauthorized - requested resource requires authentication.
404 Not Found - requested resource requires authentication.
422 Unprocessable Entity - requested resource requires authentication
500 Internal Server Error - generic error occurred on the server


Security

All API calls will require the HTTP header X-ApiKey listed above

Tools

We like using Postman when working with the API.

Change log

TDB