OneID Data Service & Partner API 1.0.0

Note: This API reference is only for our data service and partner APIs. If you are integrating with the OneID journey please use https://docs.oneid.uk/guides.

Server

https://api.oneid.uk

Production (Live data)

https://api.sandbox.oneid.uk

Sandbox (Test data)

Authentication

oauth2 OAuth

This is used for non partner APIs.

FlowClient Credentials

Token URL/v1/auth/token

Scopes

Name	Description

http Basic

Requests should be made with an Authorization header that has the value Basic base64(client_id:client_secret).

Your client_id and client_secret can be obtained from the OneID portal, or by contacting support.

oauth2 OAuthPartner

This is used for partner APIs.

FlowClient Credentials

Token URL/v1/token

Scopes

Name	Description

Authentication

We have two token APIs.

Endpoints

Create a non Partner API Token

Retrieves an API token that can be used for non Partner APIs.

Auth

Request Body

object object

grant_type

string

Must be set to client_credentials.

Enum: client_credentials

POST /v1/auth/token

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.oneid.uk/v1/auth/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic {token}' \ --data 'grant_type={grant_type}'
Copy

Responses

200

Token created

Headers
x-request-id	string	A unique ID for the request. Please quote this ID when contacting support about a request.
Body
object	object
access_token	string	The requested access token. You can use this token to authenticate to the secured APIs. You should treat this as an opaque value. Don't attempt to validate or parse the token.
token_type	string	The only type that OneID supports is `bearer`.
expires_in	int32	The amount of time that an access token is valid (in seconds).

default

Error

Response

xxxxxxxxxx
 
{ "access_token": "{string}", "token_type": "{string}", "expires_in": "{int32}"}
Copy

Create a Partner API Token

Retrieves an API token that can be used for Partner APIs.

Auth

Request Body

object object

grant_type

string

Must be set to client_credentials.

Enum: client_credentials

POST /v1/token

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.oneid.uk/v1/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic {token}' \ --data 'grant_type={grant_type}'
Copy

Responses

200

Token created

Headers
x-request-id	string	A unique ID for the request. Please quote this ID when contacting support about a request.
Body
object	object
access_token	string	The requested access token. You can use this token to authenticate to the secured APIs. You should treat this as an opaque value. Don't attempt to validate or parse the token.
token_type	string	The only type that OneID supports is `bearer`.
expires_in	int32	The amount of time that an access token is valid (in seconds).

default

Error

Response

xxxxxxxxxx
 
{ "access_token": "{string}", "token_type": "{string}", "expires_in": "{int32}"}
Copy

Identity - Lookup By Bank Account

Endpoints

POST

/v1/identity/lookup/by-bank-account

Show

Identity - Lookup By Phone Number

A sequence diagram for these APIs can be found at https://docs.oneid.uk/guides/oneid-data-services#lookup-by-phone-number-api-sequence-diagram.

Endpoints

POST

/v1/identity/lookup/by-phone-number/{id}:verify-otp

GET

/v1/identity/lookup/by-phone-number/{id}

POST

/v1/identity/lookup/by-phone-number

Show

Partner

⚠ Note: These APIs are not available in the Sandbox environment.

Endpoints

/v1/organisations/{id}

PUT

/v1/organisations/{id}

GET

/v1/organisations/{id}/clients

POST

/v1/organisations/{id}/clients

Show