API docs by Redocly

Amiqus SDK REST API (1.0)

Download OpenAPI specification:Download

Amiqus Engineering: developers@amiqus.co URL: https://developers.amiqus.co/sdk/sdk-api-reference.html

The Amiqus SDK API is used to undertake Amiqus requests on behalf of a data subject. All API requests require SDK Token authentication. SDK Tokens are generated using the Amiqus API, scoped to a single Record and are valid for 60 minutes.

SDK token status

Check validity of the SDK token and retrieve details of the scoped Record.

Authorizations:
sdk_token

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/sdk/v1/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "record_status",
  • "id": 983434,
  • "status": "pending",
  • "email": "marty@example.com",
  • "client": 73845,
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z"
}

List all steps

List all steps on record.

Authorizations:
sdk_token
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

limit
integer [ 1 .. 100 ]
Default: 25

Number of items per page

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/sdk/v1/steps?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 3,
  • "count": 3,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Submit a step

Submit a step.

Authorizations:
sdk_token
path Parameters
id
required
integer
Request Body schema: application/json
One of
title
string

The Client's name title.

Required unless provided when creating the Client.

dob
string <date>

The Client's date of birth.

Required unless provided when creating the Client.

required
Array of objects (Address Period) non-empty

12 months of address history, most recent address country must be GB.

privacy_policy
required
boolean
Value: true

Confirm the data subject has accepted TransUnion's privacy notice.

Responses

Request samples

Content type
application/json
Example
{
  • "title": "miss",
  • "dob": "1967-10-29",
  • "address_history": [
    ],
  • "privacy_policy": true
}

Response samples

Content type
application/json
{
  • "error": "Unauthenticated"
}

Other Resources

Create an Onfido SDK token

Create an Onfido SDK token for use with a Photo ID check step (standard report type only). An Onfido SDK token allows you to embed an iOS, Android or React Native Onfido SDK into your application. Onfido SDK tokens cannot be used with the Onfido Web SDK.

Onfido SDK tokens can only be used for the Photo ID check step that the Amiqus SDK token is scoped for and are valid for 90 minutes. Tokens are only valid for use with standard Photo ID report type, the biometric report type is not currently supported.

After uploading supporting documentation using the Onfido SDK, use Submit a step to submit the Photo ID check step.

Authorizations:
sdk_token
Request Body schema: application/json
bundle_id
required
string

The bundle ID (for Android "application ID") that was set up during application development. For iOS, this is usually in the form com.your-company.app-name. Make sure to use a valid bundle_id or you'll receive a 401 error from Onfido.

Responses

Request samples

Content type
application/json
{
  • "bundle_id": "com.your-company.app-name"
}

Response samples

Content type
application/json
{
  • "sdkToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjQ5OTEzNzYwMCwiZXhwIjo0OTkxMzc2NjAsIm1hcnR5IjoiU291bmRzIHByZXR0eSBoZWF2eS4iLCJkb2MiOiJXZWlnaHQgaGFzIG5vdGhpbmcgdG8gZG8gd2l0aCBpdC4iLCLwn5GLIjoiVGhpcyBpcyBub3QgYSB2YWxpZCBTREsgVG9rZW4uIn0.j2jAeX_MpagkS7qvBjF9uYYIawP_uvEPqnftEW9wDe8",
  • "flowSteps": {
    }
}
Back to top