NAV Navbar
Shell HTTP JavaScript Ruby Python PHP Java Go

Northrow API v3.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

NorthRow’s single API solution enables your organisation to digitally transform its client on-boarding, compliance and monitoring processes.

You can verify companies, individuals and ID documents with our automated Know Your Customer and identity verification solutions, to deliver Anti-Money Laundering regulatory compliance.

The NorthRow API conforms to the REST architectural style, using JSON. It uses standard HTTP response codes and verbs, and a token based authentication.

In keeping with our data providers and the changing state of technology, this documentation and the associated technology is under continuous review and subject to change. To ensure we continue to deliver marketing-leading solutions, please let us know if you have any suggestions on how we should improve this documentation further.

Before trying to use the API, a user account with an appropriate profile has to be set up. For this please email support@northrow.com or call 01235 375000.

You can configure the NorthRow solution to your requirements, by creating profiles. A profile consists of the type of verification to be performed and defines the data sources against which to validate person, company or document details.  A profile defines the rules to run against the results returned from a successful verification in order to establish a risk score, represented by the RAG (Red, Amber, Green) status.


Base URLs:

Authentication

Northrow’s API uses a Bearer authentication scheme. Bearer authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. 

Client must send this token in the Authorization header when making requests.

A Bearer token is valid for 30 minutes from time of issue. Once expired the client must request a new token for their subsequent requests.

Bearer authentication

Code samples

# You can also use wget
curl -X POST https://api.northrow.com/v3/authorise \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.northrow.com/v3/authorise HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "organisation_uid": "string",
  "access_key": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.northrow.com/v3/authorise',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.northrow.com/v3/authorise',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.northrow.com/v3/authorise', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.northrow.com/v3/authorise', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/authorise");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.northrow.com/v3/authorise", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /authorise

Body parameter

{
  "organisation_uid": "string",
  "access_key": "string"
}

Parameters

Name In Type Required Description
body body AuthoriseRequest true authoriseRequest

Example responses

200 Response

{
  "token": "string"
}

Responses

Status Meaning Description Schema
200 OK A valid token will be returned AuthorisedResponse
400 Bad Request Unrecognised fields None
401 Unauthorized Unauthorised ApiErrorResponse
500 Internal Server Error Unexpected Error None

Creating Checks

This section describes the endpoints available for creating and initiating checks.

NorthRow can verify an Individual, Company or a combination of Company and Individuals.

When submitting a check NorthRow will respond with a checkUuid to confirm the request has been received. This checkUuid is the unique identifier for the check and is used by subsequent endpoints. Receiving the checkUuid does not mean the check has completed - to receive a notification on completion, the customer must configure a callback URL.


Create a Company check

Code samples

# You can also use wget
curl -X POST https://api.northrow.com/v3/check/company \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

POST https://api.northrow.com/v3/check/company HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "company": {
    "description": "string",
    "name": "string",
    "phone": {
      "number": "string",
      "type": "mobile,landline"
    },
    "registered": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "registration_number": "string",
    "tax_number": "string",
    "trading": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "type": "string",
    "vat_number": "string",
    "website": "string"
  },
  "contacts": [
    {
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "current_address": {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      },
      "date_of_birth": "yyyy-mm-dd",
      "documents": [
        {
          "back": {
            "data": "string",
            "name": "string"
          },
          "document_uuid": "string",
          "front": {
            "data": "string",
            "name": "string"
          },
          "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "email_address": [
        "string"
      ],
      "first_name": "string",
      "gender": "male, female",
      "identification_details": [
        {
          "issuing_country": "string",
          "number": "string",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "last_name": "string",
      "middle_name": "string",
      "mpan": "string",
      "phone": [
        {
          "number": "string",
          "type": "mobile,landline"
        }
      ],
      "previous_address": [
        {
          "country": "'GB' is the country code for United Kingdom",
          "county": "string",
          "line_five": "string",
          "line_four": "string",
          "line_six": "string",
          "line_three": "string",
          "name_number": "string",
          "postcode": "string",
          "state": "string",
          "street": "string",
          "town": "string"
        }
      ],
      "title": "mr,mrs"
    }
  ],
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/company',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.post 'https://api.northrow.com/v3/check/company',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.post('https://api.northrow.com/v3/check/company', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.northrow.com/v3/check/company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.northrow.com/v3/check/company", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /check/company

Creates a single company check and returns a resource identifier for that company (a checkUuid). A company check can contain between zero and six contacts (i.e. directors).

Body parameter

{
  "company": {
    "description": "string",
    "name": "string",
    "phone": {
      "number": "string",
      "type": "mobile,landline"
    },
    "registered": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "registration_number": "string",
    "tax_number": "string",
    "trading": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "type": "string",
    "vat_number": "string",
    "website": "string"
  },
  "contacts": [
    {
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "current_address": {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      },
      "date_of_birth": "yyyy-mm-dd",
      "documents": [
        {
          "back": {
            "data": "string",
            "name": "string"
          },
          "document_uuid": "string",
          "front": {
            "data": "string",
            "name": "string"
          },
          "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "email_address": [
        "string"
      ],
      "first_name": "string",
      "gender": "male, female",
      "identification_details": [
        {
          "issuing_country": "string",
          "number": "string",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "last_name": "string",
      "middle_name": "string",
      "mpan": "string",
      "phone": [
        {
          "number": "string",
          "type": "mobile,landline"
        }
      ],
      "previous_address": [
        {
          "country": "'GB' is the country code for United Kingdom",
          "county": "string",
          "line_five": "string",
          "line_four": "string",
          "line_six": "string",
          "line_three": "string",
          "name_number": "string",
          "postcode": "string",
          "state": "string",
          "street": "string",
          "town": "string"
        }
      ],
      "title": "mr,mrs"
    }
  ],
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  }
}

Parameters

Name In Type Required Description
body body CheckCompanyRequest true checkCompanyRequest

Example responses

200 Response

{
  "check_uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns the checkUuid for the check.User will have to verify the outcome of the check in the callback response (or) using the endpoint GET /check/{checkUuid} CheckResponse
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
500 Internal Server Error Unexpected error. Please contact support team. None

Create a Person check

Code samples

# You can also use wget
curl -X POST https://api.northrow.com/v3/check/person \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

POST https://api.northrow.com/v3/check/person HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  },
  "person": {
    "bank_account": {
      "account": {
        "account_address_match": true,
        "account_name_match": true,
        "account_number_match": true,
        "account_status": "no_match",
        "sortcode_match": true
      },
      "bank": {
        "account_valid": true,
        "bank_name": "string",
        "branch_name": "string"
      }
    },
    "current_address": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "date_of_birth": "yyyy-mm-dd",
    "documents": [
      {
        "back": {
          "data": "string",
          "name": "string"
        },
        "document_uuid": "string",
        "front": {
          "data": "string",
          "name": "string"
        },
        "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "email_address": [
      "string"
    ],
    "first_name": "string",
    "gender": "male, female",
    "identification_details": [
      {
        "issuing_country": "string",
        "number": "string",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "last_name": "string",
    "middle_name": "string",
    "mpan": "string",
    "phone": [
      {
        "number": "string",
        "type": "mobile,landline"
      }
    ],
    "previous_address": [
      {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      }
    ],
    "title": "mr,mrs"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/person',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.post 'https://api.northrow.com/v3/check/person',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.post('https://api.northrow.com/v3/check/person', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.northrow.com/v3/check/person', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/person");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.northrow.com/v3/check/person", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /check/person

Creates a single person check and returns a resource identifier for that person (a checkUuid).

Body parameter

{
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  },
  "person": {
    "bank_account": {
      "account": {
        "account_address_match": true,
        "account_name_match": true,
        "account_number_match": true,
        "account_status": "no_match",
        "sortcode_match": true
      },
      "bank": {
        "account_valid": true,
        "bank_name": "string",
        "branch_name": "string"
      }
    },
    "current_address": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "date_of_birth": "yyyy-mm-dd",
    "documents": [
      {
        "back": {
          "data": "string",
          "name": "string"
        },
        "document_uuid": "string",
        "front": {
          "data": "string",
          "name": "string"
        },
        "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "email_address": [
      "string"
    ],
    "first_name": "string",
    "gender": "male, female",
    "identification_details": [
      {
        "issuing_country": "string",
        "number": "string",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "last_name": "string",
    "middle_name": "string",
    "mpan": "string",
    "phone": [
      {
        "number": "string",
        "type": "mobile,landline"
      }
    ],
    "previous_address": [
      {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      }
    ],
    "title": "mr,mrs"
  }
}

Parameters

Name In Type Required Description
body body CheckPersonRequest true checkPersonRequest

Example responses

200 Response

{
  "check_uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns the checkUuid for the check. User will have to verify the outcome of the check in the callback response (or) using the endpoint GET /check/{checkUuid} CheckResponse
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
500 Internal Server Error Unexpected error. Please contact support team. None

Check Data

This section describes the endpoints available for returning structured data from a check.

Return Company data for a check

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/data/{checkUuid}/company \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/data/{checkUuid}/company HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/data/{checkUuid}/company',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/data/{checkUuid}/company',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/data/{checkUuid}/company', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/data/{checkUuid}/company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/data/{checkUuid}/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/data/{checkUuid}/company", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/data/{checkUuid}/company

Returns all company data associated with a check. Dynamic filtering of the JSON response is also possible. Please refer to the 'Response Filtering' section for further details.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

{
  "company_data": {
    "appointment": {
      "current_directors": [
        {
          "address_data": "string",
          "dob": "string",
          "gender": "Male",
          "name": "string",
          "position": [
            {
              "appointed_date": "string",
              "role": "string"
            }
          ]
        }
      ],
      "previous_directors": [
        {
          "address_data": "string",
          "dob": "string",
          "gender": "Male",
          "name": "string",
          "position": [
            {
              "appointed_date": "string",
              "role": "string"
            }
          ]
        }
      ]
    },
    "contact_address": {
      "email": [
        "string"
      ],
      "main_address": {
        "address_data": "string",
        "telephone": "string"
      },
      "other_addresses": [
        {
          "address_data": "string",
          "telephone": "string"
        }
      ],
      "previous_addresses": [
        {
          "address_data": "string"
        }
      ],
      "website": [
        "string"
      ]
    },
    "credit_score": {
      "current_contract_limit": "string",
      "current_credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      },
      "previous_credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      }
    },
    "financial": [
      {
        "balance_sheet": {
          "bank_liabilities": "string",
          "bank_liabilities_due_after_1_year": "string",
          "called_up_share_capital": "string",
          "cash": "string",
          "finished_goods": "string",
          "goodwill": "string",
          "group_payables": "string",
          "group_payables_due_after_1_year": "string",
          "group_receivables": "string",
          "investments": "string",
          "land_and_buildings": "string",
          "loans_to_group": "string",
          "miscellaneous_fixed_assets": "string",
          "miscellaneous_liabilities": "string",
          "miscellaneous_liabilities_due_after_1_year": "string",
          "miscellaneous_receivables": "string",
          "other_current_assets": "string",
          "other_intangible_assets": "string",
          "other_inventories": "string",
          "other_loans": "string",
          "other_loans_or_finance": "string",
          "other_loans_or_finance_due_after_1_year": "string",
          "other_reserves": "string",
          "other_tangible_assets": "string",
          "plant_and_machinery": "string",
          "raw_materials": "string",
          "receivables_due_after_1_year": "string",
          "revenue_reserves": "string",
          "share_premium": "string",
          "total_assets": "string",
          "total_current_assets": "string",
          "total_current_liabilities": "string",
          "total_fixed_assets": "string",
          "total_intangible_assets": "string",
          "total_inventories": "string",
          "total_liabilities": "string",
          "total_long_term_liabilities": "string",
          "total_other_fixed_assets": "string",
          "total_receivables": "string",
          "total_shareholders_equity": "string",
          "total_tangible_assets": "string",
          "trade_payables": "string",
          "trade_payables_due_after_1_year": "string",
          "trade_receivables": "string",
          "work_in_progress": "string"
        },
        "currency": "string",
        "is_consolidated_accounts": true,
        "number_of_weeks": "string",
        "other_financials": {
          "contingent_liabilities": "string",
          "net_worth": "string",
          "working_capital": "string"
        },
        "profit_and_loss": {
          "amortisation": "string",
          "depreciation": "string",
          "dividends": "string",
          "extraordinary_costs": "string",
          "extraordinary_income": "string",
          "financial_expenses": "string",
          "financial_income": "string",
          "minority_interests": "string",
          "operating_costs": "string",
          "operating_profit": "string",
          "other_appropriations": "string",
          "pension_costs": "string",
          "profit_after_tax": "string",
          "profit_before_tax": "string",
          "retained_profit": "string",
          "revenue": "string",
          "tax": "string",
          "wages_and_salaries": "string"
        },
        "ratios": {
          "creditor_days": "string",
          "current_debt_ratio": "string",
          "current_ratio": "string",
          "debtor_days": "string",
          "equity_in_percentage": "string",
          "gearing": "string",
          "liquidity_ratio_or_acid_test": "string",
          "pre_tax_profit_margin": "string",
          "return_on_captial_employed": "string",
          "return_on_net_assets_employed": "string",
          "return_on_total_assets_employed": "string",
          "sales_or_net_working_capital": "string",
          "stock_turnover_ratio": "string",
          "total_debt_ratio": "string"
        },
        "year_end_date": "string"
      }
    ],
    "general_information": {
      "VAT": {
        "registration_date": "string",
        "registration_number": "string"
      },
      "activities": [
        {
          "code": "string",
          "description": "string"
        }
      ],
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "business_name": "string",
      "credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      },
      "date_of_registration": "string",
      "date_of_starting_operations": "string",
      "latest_shareholders_equity": "string",
      "latest_turnover": "string",
      "legal_form": "string",
      "phone_number": "string",
      "previous_names": [
        {
          "date_changed": "string",
          "name": "string"
        }
      ],
      "registered_company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type_of_ownership": "string"
    },
    "group_structure": {
      "affiliated_companies": [
        {
          "address_data": "string",
          "company_name": "string",
          "registration_number": "string",
          "status": "string",
          "type": "string",
          "vat_number": "string"
        }
      ],
      "immediate_parent": {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      },
      "subsidiary_companies": [
        {
          "address_data": "string",
          "company_name": "string",
          "registration_number": "string",
          "status": "string",
          "type": "string",
          "vat_number": "string"
        }
      ],
      "ultimate_parent": {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      }
    },
    "lei": {
      "lei_number": "string"
    },
    "peps_and_sanctions": [
      {
        "address": [
          {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          }
        ],
        "aliases": [
          {
            "first_name": "string",
            "last_name": "string",
            "middle_name": "string"
          }
        ],
        "articles": [
          {
            "categories": [
              "string"
            ],
            "date_collected": "string",
            "original_url": "string",
            "provider_url": "string",
            "snippet": {
              "keywords_matched": [
                "string"
              ],
              "summary": "string",
              "title": "string"
            }
          }
        ],
        "business_name": "string",
        "fax_number": "string",
        "is_adverse_media": true,
        "is_disqualified_director": true,
        "is_financial_regulator": true,
        "is_insolvent": true,
        "is_law_enforcement": true,
        "is_pep": true,
        "is_sanctions_current": true,
        "is_sanctions_previous": true,
        "linked_businesses": [
          {
            "business_name": "string",
            "position": "string"
          }
        ],
        "linked_persons": [
          {
            "association": "string",
            "name": "string"
          }
        ],
        "notes": [
          {
            "data_source": "string",
            "snippet": [
              {
                "keywords_matched": [
                  "string"
                ],
                "summary": "string",
                "title": "string"
              }
            ],
            "text": "string"
          }
        ],
        "sanctions": [
          {
            "is_current": true,
            "sanction_type": "string"
          }
        ],
        "score": 0,
        "telephone_number": "string",
        "website": "string"
      }
    ],
    "persons_with_significant_control": [
      {
        "address": {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        },
        "country_of_residence": "string",
        "dob": {
          "month": "string",
          "year": "string"
        },
        "identification": {
          "country_registered": "string",
          "legal_authority": "string",
          "legal_form": "string",
          "place_registered": "string",
          "registration_number": "string"
        },
        "name": "string",
        "nationality": "string",
        "natures_of_control": [
          "string"
        ],
        "notified_on": "string",
        "type": "INDIVIDUAL"
      }
    ],
    "shareholder_information": {
      "issued_share_capital": "string",
      "nominal_share_capital": "string",
      "shareholders": [
        {
          "address_data": "string",
          "name": "string",
          "share_percent": "string"
        }
      ]
    },
    "ultimate_beneficial_owner": {
      "resolution": {
        "code": "string",
        "description": "string"
      },
      "search_level_details": [
        {
          "beneficial_owners": [
            {
              "name": "string",
              "owner_type": "string",
              "reason": "string"
            }
          ],
          "company_name": "string",
          "company_registration_number": "string",
          "country": "string",
          "search_level": 0
        }
      ]
    }
  },
  "person_data": [
    {
      "address": [
        {
          "address_detail": {
            "match_sources": [
              {
                "source": "string",
                "year": "string"
              }
            ],
            "occupants": [
              {
                "dob": "yyyy-mm-dd",
                "match_sources": [
                  {
                    "source": "string",
                    "year": "string"
                  }
                ],
                "name": "string",
                "phone_number": "string",
                "recency": "yyyy-mm-dd",
                "residency": "string"
              }
            ],
            "property": {
              "matches": [
                {
                  "match_type": "string",
                  "ownership_type": "joint_ownership",
                  "title_number": "string"
                }
              ],
              "sale_date": "string",
              "sale_price": "string",
              "tenure": "freehold",
              "type": "terrace"
            }
          },
          "address_type": "current",
          "bank_account": {
            "account": {
              "account_address_match": true,
              "account_name_match": true,
              "account_number_match": true,
              "account_status": "no_match",
              "sortcode_match": true
            },
            "bank": {
              "account_valid": true,
              "bank_name": "string",
              "branch_name": "string"
            }
          },
          "credit_agencies": {
            "accounts": 0,
            "lenders": 0
          },
          "death_register": [
            {
              "address": {
                "address_line1": "string",
                "address_line2": "string",
                "address_line3": "string",
                "address_line4": "string",
                "address_line5": "string",
                "country": "string",
                "postcode": "string"
              },
              "date_of_death": "string",
              "date_of_registration": "string",
              "district": "string",
              "dob": "string",
              "first_name": "string",
              "gro_reference": "string",
              "last_name": "string",
              "match_type": "string",
              "middle_name": "string",
              "mothers_maiden_name": "string",
              "place_of_birth": "string"
            }
          ],
          "dob": "yyyy-mm-dd",
          "dob_validated": 0,
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "mpan_result": true,
          "phone_match": [
            "string"
          ]
        }
      ],
      "court_judgement": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "amount": "string",
          "case_number": "string",
          "court_name": "string",
          "dob": "string",
          "end_date": "string",
          "issued_date": "string",
          "name": "string",
          "type": "string"
        }
      ],
      "documents": [
        {
          "check_uuid": "string",
          "country_code": "string",
          "date_of_birth": "string",
          "document_description": "string",
          "document_number": "string",
          "document_uuid": "string",
          "error_msg": "string",
          "expiry_date": "string",
          "first_name": "string",
          "gender": "string",
          "has_document_report": true,
          "id_type": "string",
          "is_expired": true,
          "is_mrz_validated": true,
          "last_name": "string",
          "mrz_line_1": "string",
          "mrz_line_2": "string",
          "mrz_line_3": "string",
          "nationality": "string",
          "notes": [
            "string"
          ],
          "personal_number": "string",
          "provider": "string",
          "providers_used": [
            "string"
          ],
          "status": "CHECKED_PASSED",
          "supplier_guid": "string"
        }
      ],
      "insolvencies": [
        {
          "address": [
            {
              "address_line1": "string",
              "address_line2": "string",
              "address_line3": "string",
              "address_line4": "string",
              "address_line5": "string",
              "country": "string",
              "postcode": "string"
            }
          ],
          "aliases": [
            "string"
          ],
          "asset_total": 0,
          "case_description": "string",
          "case_number": "string",
          "case_type": "string",
          "court": "string",
          "debt_total": 0,
          "dob": "string",
          "name": "string",
          "occupation": "string",
          "presentation_date": "string",
          "service_office": "string",
          "start_date": "string",
          "status": "string",
          "trading_name": "string",
          "type": "string"
        }
      ],
      "officer_directorships": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "address_line6": "string",
            "country": "string",
            "postcode": "string"
          },
          "directorships": [
            {
              "appointed_date": "string",
              "company_name": "string",
              "company_number": "string",
              "company_status": "string",
              "position": "string",
              "resignation_date": "string",
              "type": "string"
            }
          ],
          "dob": "string",
          "name": "string",
          "nationality": "string"
        }
      ],
      "officer_disqualifications": [
        {
          "company_number": "string",
          "country_of_registration": "string",
          "disqualifications": [
            {
              "address": {
                "address_line1": "string",
                "address_line2": "string",
                "address_line3": "string",
                "address_line4": "string",
                "address_line5": "string",
                "country": "string",
                "postcode": "string"
              },
              "company_names": [
                "string"
              ],
              "disqualification_type": "string",
              "end_date": "string",
              "reason": {
                "act": "string",
                "article": "string",
                "description_identifier": "string",
                "section": "string"
              },
              "start_date": "string"
            }
          ],
          "dob": "string",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string"
        }
      ],
      "peps_and_sanctions": [
        {
          "address": [
            {
              "address_line1": "string",
              "address_line2": "string",
              "address_line3": "string",
              "address_line4": "string",
              "address_line5": "string",
              "country": "string",
              "postcode": "string"
            }
          ],
          "aliases": [
            {
              "first_name": "string",
              "last_name": "string",
              "middle_name": "string"
            }
          ],
          "articles": [
            {
              "categories": [
                "string"
              ],
              "date_collected": "string",
              "original_url": "string",
              "provider_url": "string",
              "snippet": {
                "keywords_matched": [
                  "string"
                ],
                "summary": "string",
                "title": "string"
              }
            }
          ],
          "dob": "string",
          "dod": "string",
          "email": "string",
          "first_name": "string",
          "gender": "string",
          "image_url": "string",
          "is_adverse_media": true,
          "is_deceased": true,
          "is_disqualified_director": true,
          "is_financial_regulator": true,
          "is_insolvent": true,
          "is_law_enforcement": true,
          "is_pep": true,
          "is_sanctions_current": true,
          "is_sanctions_previous": true,
          "last_name": "string",
          "linked_businesses": [
            {
              "business_name": "string",
              "position": "string"
            }
          ],
          "linked_persons": [
            {
              "association": "string",
              "name": "string"
            }
          ],
          "middle_name": "string",
          "mobile_number": "string",
          "nationality": "string",
          "notes": [
            {
              "data_source": "string",
              "snippet": [
                {
                  "keywords_matched": [
                    "string"
                  ],
                  "summary": "string",
                  "title": "string"
                }
              ],
              "text": "string"
            }
          ],
          "pep_level": "string",
          "political_positions": [
            {
              "country": "string",
              "description": "string",
              "end_date": "string",
              "start_date": "string"
            }
          ],
          "sanctions": [
            {
              "is_current": true,
              "sanction_type": "string"
            }
          ],
          "score": "string",
          "telephone_number": "string",
          "year_of_birth": "string",
          "year_of_death": "string"
        }
      ],
      "person_index": 0,
      "social": {
        "age": "string",
        "education": [
          {
            "degree": "string",
            "name": "string",
            "year": 0
          }
        ],
        "email": "string",
        "employment": [
          {
            "current": true,
            "name": "string",
            "title": "string"
          }
        ],
        "first_name": "string",
        "gender": "string",
        "last_name": "string",
        "locations": [
          {
            "city": "string",
            "country": "string",
            "region": "string"
          }
        ],
        "photos": [
          {
            "label": "string",
            "url": "string"
          }
        ],
        "profiles": [
          {
            "bio": "string",
            "name": "string",
            "url": "string"
          }
        ]
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK AllProviderData
403 Forbidden Forbidden None
404 Not Found Check is still processing. None
500 Internal Server Error Unexpected error. Please contact support team. None

Return Person data for a check

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/data/{checkUuid}/person \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/data/{checkUuid}/person HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/data/{checkUuid}/person',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/data/{checkUuid}/person',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/data/{checkUuid}/person', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/data/{checkUuid}/person', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/data/{checkUuid}/person");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/data/{checkUuid}/person", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/data/{checkUuid}/person

Returns all person data associated with a check. Dynamic filtering of the JSON response is also possible. Please refer to the 'Response Filtering' section for further details.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

{
  "address": [
    {
      "address_detail": {
        "match_sources": [
          {
            "source": "string",
            "year": "string"
          }
        ],
        "occupants": [
          {
            "dob": "yyyy-mm-dd",
            "match_sources": [
              {
                "source": "string",
                "year": "string"
              }
            ],
            "name": "string",
            "phone_number": "string",
            "recency": "yyyy-mm-dd",
            "residency": "string"
          }
        ],
        "property": {
          "matches": [
            {
              "match_type": "string",
              "ownership_type": "joint_ownership",
              "title_number": "string"
            }
          ],
          "sale_date": "string",
          "sale_price": "string",
          "tenure": "freehold",
          "type": "terrace"
        }
      },
      "address_type": "current",
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "credit_agencies": {
        "accounts": 0,
        "lenders": 0
      },
      "death_register": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "date_of_death": "string",
          "date_of_registration": "string",
          "district": "string",
          "dob": "string",
          "first_name": "string",
          "gro_reference": "string",
          "last_name": "string",
          "match_type": "string",
          "middle_name": "string",
          "mothers_maiden_name": "string",
          "place_of_birth": "string"
        }
      ],
      "dob": "yyyy-mm-dd",
      "dob_validated": 0,
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "mpan_result": true,
      "phone_match": [
        "string"
      ]
    }
  ],
  "court_judgement": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "amount": "string",
      "case_number": "string",
      "court_name": "string",
      "dob": "string",
      "end_date": "string",
      "issued_date": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "documents": [
    {
      "check_uuid": "string",
      "country_code": "string",
      "date_of_birth": "string",
      "document_description": "string",
      "document_number": "string",
      "document_uuid": "string",
      "error_msg": "string",
      "expiry_date": "string",
      "first_name": "string",
      "gender": "string",
      "has_document_report": true,
      "id_type": "string",
      "is_expired": true,
      "is_mrz_validated": true,
      "last_name": "string",
      "mrz_line_1": "string",
      "mrz_line_2": "string",
      "mrz_line_3": "string",
      "nationality": "string",
      "notes": [
        "string"
      ],
      "personal_number": "string",
      "provider": "string",
      "providers_used": [
        "string"
      ],
      "status": "CHECKED_PASSED",
      "supplier_guid": "string"
    }
  ],
  "insolvencies": [
    {
      "address": [
        {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        }
      ],
      "aliases": [
        "string"
      ],
      "asset_total": 0,
      "case_description": "string",
      "case_number": "string",
      "case_type": "string",
      "court": "string",
      "debt_total": 0,
      "dob": "string",
      "name": "string",
      "occupation": "string",
      "presentation_date": "string",
      "service_office": "string",
      "start_date": "string",
      "status": "string",
      "trading_name": "string",
      "type": "string"
    }
  ],
  "officer_directorships": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "address_line6": "string",
        "country": "string",
        "postcode": "string"
      },
      "directorships": [
        {
          "appointed_date": "string",
          "company_name": "string",
          "company_number": "string",
          "company_status": "string",
          "position": "string",
          "resignation_date": "string",
          "type": "string"
        }
      ],
      "dob": "string",
      "name": "string",
      "nationality": "string"
    }
  ],
  "officer_disqualifications": [
    {
      "company_number": "string",
      "country_of_registration": "string",
      "disqualifications": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "company_names": [
            "string"
          ],
          "disqualification_type": "string",
          "end_date": "string",
          "reason": {
            "act": "string",
            "article": "string",
            "description_identifier": "string",
            "section": "string"
          },
          "start_date": "string"
        }
      ],
      "dob": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    }
  ],
  "peps_and_sanctions": [
    {
      "address": [
        {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        }
      ],
      "aliases": [
        {
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string"
        }
      ],
      "articles": [
        {
          "categories": [
            "string"
          ],
          "date_collected": "string",
          "original_url": "string",
          "provider_url": "string",
          "snippet": {
            "keywords_matched": [
              "string"
            ],
            "summary": "string",
            "title": "string"
          }
        }
      ],
      "dob": "string",
      "dod": "string",
      "email": "string",
      "first_name": "string",
      "gender": "string",
      "image_url": "string",
      "is_adverse_media": true,
      "is_deceased": true,
      "is_disqualified_director": true,
      "is_financial_regulator": true,
      "is_insolvent": true,
      "is_law_enforcement": true,
      "is_pep": true,
      "is_sanctions_current": true,
      "is_sanctions_previous": true,
      "last_name": "string",
      "linked_businesses": [
        {
          "business_name": "string",
          "position": "string"
        }
      ],
      "linked_persons": [
        {
          "association": "string",
          "name": "string"
        }
      ],
      "middle_name": "string",
      "mobile_number": "string",
      "nationality": "string",
      "notes": [
        {
          "data_source": "string",
          "snippet": [
            {
              "keywords_matched": [
                "string"
              ],
              "summary": "string",
              "title": "string"
            }
          ],
          "text": "string"
        }
      ],
      "pep_level": "string",
      "political_positions": [
        {
          "country": "string",
          "description": "string",
          "end_date": "string",
          "start_date": "string"
        }
      ],
      "sanctions": [
        {
          "is_current": true,
          "sanction_type": "string"
        }
      ],
      "score": "string",
      "telephone_number": "string",
      "year_of_birth": "string",
      "year_of_death": "string"
    }
  ],
  "person_index": 0,
  "social": {
    "age": "string",
    "education": [
      {
        "degree": "string",
        "name": "string",
        "year": 0
      }
    ],
    "email": "string",
    "employment": [
      {
        "current": true,
        "name": "string",
        "title": "string"
      }
    ],
    "first_name": "string",
    "gender": "string",
    "last_name": "string",
    "locations": [
      {
        "city": "string",
        "country": "string",
        "region": "string"
      }
    ],
    "photos": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "profiles": [
      {
        "bio": "string",
        "name": "string",
        "url": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK OK CombinedPersonData
403 Forbidden Forbidden None
404 Not Found Check is still processing. None
500 Internal Server Error Unexpected error. Please contact support team. None

Check Reports

This section describes the endpoints available for returning reports associated with a check.

Return check report

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/report \
  -H 'Accept: application/pdf' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/report HTTP/1.1

Accept: application/pdf


const headers = {
  'Accept':'application/pdf',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/pdf',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/pdf',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/report', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/pdf',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/pdf"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/report

Returns a PDF report of a check. Returns a binary data representing the PDF.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the pdf report integer
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Return a list of supplier reports

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/supplier_report \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/supplier_report HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/supplier_report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/supplier_report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/supplier_report', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/supplier_report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/supplier_report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/supplier_report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/supplier_report

List all supplier reports associated with a check. Supplier reports are supporting information from third party data suppliers. Refer to the report response schema for details.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

{
  "contact_index": 0,
  "contact_name": "string",
  "document_uuid": "string",
  "mime_type": "string",
  "report_uuid": "string",
  "supplier_name": "string",
  "type": "string"
}

Responses

Status Meaning Description Schema
200 OK List of reports will be returned ReportResponse
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check request found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Return a specific supplier report

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid} \
  -H 'Accept: application/octet-stream' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid} HTTP/1.1

Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/octet-stream',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/octet-stream"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/supplier_report/{report_uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/supplier_report/{report_uuid}

Retrieve a supplier report belonging to a check based on the supplier report_uuid. Download the supporting information from a third part data supplier.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid
report_uuid path string true report_uuid

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK integer
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found The given UUID or ReportUUID do not exist None
500 Internal Server Error Unexpected error. Please contact support team. None

Searching Checks

This section describes the endpoints available for searching checks.

Please note, when using the Search check(s) endpoint a maximum of 10,000 checks will be returned.


Search check(s)

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check

Lists all the checks that match the specified query parameters. Results can also be sorted in ascending or descending order based on the specified sort parameters. For more information on the accepted query and sort parameters see below. Results from this endpoint will be paginated to 100 items by default.For example: /v3/check?sort=dscdate&rag=green

Parameters

Name In Type Required Description
category query string false Category of the check
center_location query string false Center location used in the check
client_name query string false Name of the client used in the check
company_name query string false Name of the company used in the check
date_end query string(date-time) false Date up to which check(s) will be retrieved in YYYY-MM-dd HH:mm:ss format
date_start query string(date-time) false Date from which check(s) will be retrieved in YYYY-MM-dd HH:mm:ss format
has_document query boolean false Determines if a document was used in the check
limit query integer(int32) false Limit of the number of records returned, maximum 100
offset query integer(int32) false Offset returned
profile query string false Profile uuid used to perform the check
rag query string false ‘RAG’ (red, amber, green, waiting) status for the check
sort query string false

Sort order followed by the sort field. Default sort order is dscdate.

Accepted sort orders are : asc,dsc

Accepted sort fields are :

  • date
  • status
  • score
  • document_count
  • uuid
  • transaction_reference
  • rag
  • centre_name
  • user
  • company_name
  • client_name
  • category
  • suspicious
  • profile_name
eg : 'ascdate' will sort in ascending order of the check date.

eg : 'dscdocument_count' will sort in descending order number of documents included in a check.

Passing invalid sortfields will use the default sort ie : 'dscdate'.

status query string false The status of the check
transaction_reference query string false Transaction reference used in the check
user query string false Username of the user who performed the check

Enumerated Values

Parameter Value
category person
category company
has_document true
has_document false
rag red
rag amber
rag green
rag waiting
status live
status archived

Example responses

200 Response

{
  "limit": 0,
  "offset": 0,
  "results": [
    {
      "alerts": [
        {
          "category": "Person,Company,ID,Other,Risk",
          "crid": "string",
          "message": "string",
          "score": 0,
          "type": "alert, info, verification"
        }
      ],
      "category": "person, company",
      "center_location": "string",
      "client_name": "string",
      "company_name": "string",
      "date": "yyyy-MM-dd HH:mm:ss",
      "document_count": 0,
      "error_messages": [
        "string"
      ],
      "org_uid": "string",
      "profile": {
        "bio": "string",
        "name": "string",
        "url": "string"
      },
      "rag": "red, amber, green, waiting",
      "score": 0,
      "status": "live, archived",
      "suspicious": true,
      "transaction_reference": "string",
      "user": "string",
      "uuid": "string"
    }
  ],
  "sort_field": "string",
  "sort_order": "string",
  "total_records": 0
}

Responses

Status Meaning Description Schema
200 OK Check(s) satifying the criteria will be returned CheckSummaryResponse
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
500 Internal Server Error Unexpected error. Please contact support team. None

Return a summary for a check

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid} HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}

Returns summary information associated with the check. Includes the overall RAG, score, and alerts along with some basic details of the check.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

{
  "alerts": [
    {
      "category": "Person,Company,ID,Other,Risk",
      "crid": "string",
      "message": "string",
      "score": 0,
      "type": "alert, info, verification"
    }
  ],
  "category": "person, company",
  "center_location": "string",
  "client_name": "string",
  "company_name": "string",
  "date": "yyyy-MM-dd HH:mm:ss",
  "document_count": 0,
  "error_messages": [
    "string"
  ],
  "org_uid": "string",
  "profile": {
    "bio": "string",
    "name": "string",
    "url": "string"
  },
  "rag": "red, amber, green, waiting",
  "score": 0,
  "status": "live, archived",
  "suspicious": true,
  "transaction_reference": "string",
  "user": "string",
  "uuid": "string"
}

Responses

Status Meaning Description Schema
200 OK Check summary for the check will be returned CheckSummary
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Modifying Checks

This section describes the endpoints available for modifying an existing check.

Delete a check

Code samples

# You can also use wget
curl -X DELETE https://api.northrow.com/v3/check/{checkUuid} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer '

DELETE https://api.northrow.com/v3/check/{checkUuid} HTTP/1.1

Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.delete 'https://api.northrow.com/v3/check/{checkUuid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.delete('https://api.northrow.com/v3/check/{checkUuid}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.northrow.com/v3/check/{checkUuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.northrow.com/v3/check/{checkUuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /check/{checkUuid}

Deletes a single check. All data associated with the check will be permanently deleted after a deletion delay based on the customers data retention policy. However, it is possible to restore the data during the delay period. After deletion, the data associated with the check cannot be recovered and we will not be able to troubleshoot.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

400 Response

Responses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Update a check

Code samples

# You can also use wget
curl -X PATCH https://api.northrow.com/v3/check/{checkUuid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

PATCH https://api.northrow.com/v3/check/{checkUuid} HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "archived_status": false,
  "note": "string",
  "rag": "red, amber, green"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.patch 'https://api.northrow.com/v3/check/{checkUuid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.patch('https://api.northrow.com/v3/check/{checkUuid}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.northrow.com/v3/check/{checkUuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.northrow.com/v3/check/{checkUuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /check/{checkUuid}

Updates the RAG value and status of a check. The RAG value can be updated to either red, green, or amber. The check status can be updated from live to archived status or from archived to live. It is mandatory to provide a note when updating a check.

Body parameter

{
  "archived_status": false,
  "note": "string",
  "rag": "red, amber, green"
}

Parameters

Name In Type Required Description
checkUuid path string true checkUuid
body body CheckUpdate true checkUpdate

Example responses

400 Response

{
  "code": "string",
  "error": "string",
  "errorDetail": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "path": "string",
  "status": 0,
  "timestamp": "string"
}

Responses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Access Denied None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Check Notes

This section describes the endpoints available for interacting with notes attached to a check.

Return notes

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/note \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/note HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/note',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/note',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/note', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/note', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/note");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/note", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/note

List all notes associated with a check.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

[
  {
    "added_date": "string",
    "note_content": "string",
    "user": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
500 Internal Server Error Unexpected error. Please contact support team. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CheckNotesResponse] false none none
» CheckNotesResponse CheckNotesResponse false none none
»» added_date string false none The date the note was added
»» note_content string false none The text content of the note
»» user string false none The name of the user who added the note

Add a note to an existing check

Code samples

# You can also use wget
curl -X POST https://api.northrow.com/v3/check/{checkUuid}/note \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

POST https://api.northrow.com/v3/check/{checkUuid}/note HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "note": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/note',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.post 'https://api.northrow.com/v3/check/{checkUuid}/note',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.post('https://api.northrow.com/v3/check/{checkUuid}/note', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.northrow.com/v3/check/{checkUuid}/note', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/note");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.northrow.com/v3/check/{checkUuid}/note", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /check/{checkUuid}/note

Add a new note to specific check.

Body parameter

{
  "note": "string"
}

Parameters

Name In Type Required Description
checkUuid path string true checkUuid
body body CheckNoteRequest true noteRequest

Example responses

400 Response

{
  "code": "string",
  "error": "string",
  "errorDetail": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "path": "string",
  "status": 0,
  "timestamp": "string"
}

Responses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Access Denied None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Check Documents

This section describes the endpoints available for interacting with documents attached to a check.

List documents for a check

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/document \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/document HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/document',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/document',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/document', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/document', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/document

Lists all documents belonging to a check. Refer to the document summary schema for details.

Parameters

Name In Type Required Description
checkUuid path string true checkUuid

Example responses

200 Response

[
  {
    "document_uuid": "string",
    "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
    "name_back": "string",
    "name_front": "string",
    "type": "passport, driving_licence, residence_permit, visa, id_card, other",
    "uploaded_date": "yyyy-MM-dd HH:mm:ss"
  }
]

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DocumentSummary] false none none
» DocumentSummary DocumentSummary false none none
»» document_uuid string false none uuid of the document attached to the check
»» mime_type string false none The mime type of the uploaded document
»» name_back string false none The name of the back side of the uploaded document with the extension. (only included if data is present)
»» name_front string false none The name of the front side of the uploaded document with the extension
»» type string false none The type of the uploaded document
»» uploaded_date string false none Date when the document was attached to the check in yyyy-MM-dd HH:mm:ss format

Add additional document

Code samples

# You can also use wget
curl -X POST https://api.northrow.com/v3/check/{checkUuid}/document \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

POST https://api.northrow.com/v3/check/{checkUuid}/document HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "data": "string",
  "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/document',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.post 'https://api.northrow.com/v3/check/{checkUuid}/document',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.post('https://api.northrow.com/v3/check/{checkUuid}/document', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.northrow.com/v3/check/{checkUuid}/document', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.northrow.com/v3/check/{checkUuid}/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /check/{checkUuid}/document

Upload an additional document to a check. Additional documents will be linked to the check but will not be sent for document verification.

Body parameter

{
  "data": "string",
  "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
  "name": "string"
}

Parameters

Name In Type Required Description
checkUuid path string true checkUuid
body body CheckAddDocumentRequest true checkAddDocumentRequest

Example responses

400 Response

{
  "code": "string",
  "error": "string",
  "errorDetail": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "path": "string",
  "status": 0,
  "timestamp": "string"
}

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found No check found with the provided uuid None
500 Internal Server Error Unexpected error. Please contact support team. None

Return a document

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide} HTTP/1.1

Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/check/{checkUuid}/document/{documentUuid}/{documentSide}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /check/{checkUuid}/document/{documentUuid}/{documentSide}

Retrieve a single document belonging to the check based on the 'documentUuid'. The 'documentUuid' for a document can be obtained by calling the 'List documents for a check' endpoint.

Parameters

Name In Type Required Description
checkUuid path string true The unique identifier for the check
documentSide path string true The side of the document to retrieve. Accepted values are: front: for front side , back: for back side
documentUuid path string true The unique identifier of the document attached to the check

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK integer
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
404 Not Found The given UUID does not exist. None
500 Internal Server Error Unexpected error. Please contact support team. None

Return Profiles

This section describes the endpoints available for interacting with the API user's profiles.

Return my profiles

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer '

GET https://api.northrow.com/v3/profile HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer <JWT_TOKEN>'

};

fetch('https://api.northrow.com/v3/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <JWT_TOKEN>'
}

result = RestClient.get 'https://api.northrow.com/v3/profile',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <JWT_TOKEN>'
}

r = requests.get('https://api.northrow.com/v3/profile', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <JWT_TOKEN>',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/profile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer <JWT_TOKEN>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/profile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /profile

Lists all the active profiles associated with the user. Refer to the profile summary response schema for further details.

Example responses

200 Response

[
  {
    "name": "string",
    "uuid": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK A list of user profiles will be returned Inline
400 Bad Request Bad Request ApiErrorResponse
403 Forbidden Forbidden None
500 Internal Server Error Unexpected error. Please contact support team. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ProfileSummary] false none none
» ProfileSummary ProfileSummary false none none
»» name string false none Profile name of the profile used in the check
»» uuid string false none Profile UUID of the profile used in the check

Response Filtering

Check responses retrieved by 'Return person data' or 'Return company data' can be filtered to return only specified fields by passing query string to the endpoints, as follows:

GET /check/data/{checkUuid}/person?fields=

GET /check/data/{checkUuid}/company?fields=

For filtering example, consider the below response

{
"person_data": [{
 "person_index": 0,
 "address": [{
 "address_type": "current",
 "first_name": "FIONA",
 "last_name": "STONE",
 "dob": "1978-08-10",
 "address_detail":{
 "occupants": [{
 "name": "FIONA STONE",
 "recency": "2020-10-15",
 "residency": "2018",
 "match_sources": [{
 "year": "2019",
 "source": "ER2019"},
 {
 "year": "2020",
 "source": "ER2020"
 }]}]},
 "dob_validated": 1,
 "mpan_result": true,
 "credit_agencies": {
 "lenders": 1,
 "accounts": 0
 },
 "bank_account": {
 "account": {
 "sortcode_match": true,
 "account_number_match": true,
 "account_name_match": true,
 "account_address_match": true
 },
 "bank": {
 "account_valid": true
 }}}]}]
}

Filtering Options

1. Select all fields

?fields=*

response returned = Returns the same json as the example

2. Select single field

?fields=person_data

response returned = Returns the same json as the example

4. Select using dot syntax

?fields=person_data.address.address_type

response returned = {"person_data":[{"address":[{"address_type":"current"}]}]}

3. Select multiple fields

?fields=person_data.address.first_name, person_data.address.last_name, person_data.address.dob

response returned = {"person_data":[{"address":[{"first_name":"FIONA","last_name":"STONE","dob":"1978-08-10"}]}]}

5. Select all fields starting with a specific character

?fields=person_data.address.d*

response returned = {"person_data":[{"address":[{"dob":"1978-08-10","dob_validated":1}]}]}

6. Excluding fields

?fields=-person_data.address.first_name

response returned = Returns the same json as the example except the first name

Callback Function

NorthRow can support callback URLs which can alert customers when a check is completed. To use this function, please contact support@northrow.com and provide us with your URL. After completing the check NorthRow will make a HTTP POST request to the callback URL provided.

The body of the request will contain the result of the NorthRow check. Callback URL can be configured at an Organisation level.

Upon receiving a callback request clients must acknowledge a success by responding with an HTTP 20x response.

If a successful acknowledgement is not received from the customer then NorthRow will attempt to resend the notification to the customer five times before giving up.

Callback response will be using the 'CheckSummaryResponse' format.


Callback Authentication

NorthRow can optionally sign the callback events it sends to your endpoint by including a signature in each event's HTTP header. The payload of the callback will be authenticated with a hash-based message authentication code (HMAC).

The key used to create the HMAC is a shared secret, which you verify by running the algorithm yourself against the payload of the callback and the key to re-create the HMAC.

This will allow you to verify that events were sent by NorthRow and not a third party.

Shared Secret

Before you can verify signatures, you need to supply NorthRow with a shared secret. The shared secret will be stored along side your organisation's callback endpoint in the NorthRow platform.

Algorithm

The HMAC is created with the HMAC-SHA256 algorithm using your shared secret, then encoded in base64.

The HMAC is attached to the callback request in the X-NorthRow-Signature header.

Verifying the signature

Your web application should verify the call-back is from NorthRow: 

  1. Extract the signature value from the header

  2. Decode the value from base64 to a hex string

  3. Determine the expected signature by computing an HMAC with the HMAC-SHA256 hash function. Use the shared secret and the JSON payload from the call-back as the message (i.e. the request body).

  4. Compare the signature in the header to the expected signature.

  5. Respond with the appropriate HTTP status code

Versioning

This will detail the current version of the application

Return version

Code samples

# You can also use wget
curl -X GET https://api.northrow.com/v3/version \
  -H 'Accept: */*'

GET https://api.northrow.com/v3/version HTTP/1.1

Accept: */*


const headers = {
  'Accept':'*/*'

};

fetch('https://api.northrow.com/v3/version',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.northrow.com/v3/version',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.northrow.com/v3/version', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.northrow.com/v3/version', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.northrow.com/v3/version");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.northrow.com/v3/version", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /version

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK 200 OK VersionResponse

Schemas

AddressData

{
  "address_detail": {
    "match_sources": [
      {
        "source": "string",
        "year": "string"
      }
    ],
    "occupants": [
      {
        "dob": "yyyy-mm-dd",
        "match_sources": [
          {
            "source": "string",
            "year": "string"
          }
        ],
        "name": "string",
        "phone_number": "string",
        "recency": "yyyy-mm-dd",
        "residency": "string"
      }
    ],
    "property": {
      "matches": [
        {
          "match_type": "string",
          "ownership_type": "joint_ownership",
          "title_number": "string"
        }
      ],
      "sale_date": "string",
      "sale_price": "string",
      "tenure": "freehold",
      "type": "terrace"
    }
  },
  "address_type": "current",
  "bank_account": {
    "account": {
      "account_address_match": true,
      "account_name_match": true,
      "account_number_match": true,
      "account_status": "no_match",
      "sortcode_match": true
    },
    "bank": {
      "account_valid": true,
      "bank_name": "string",
      "branch_name": "string"
    }
  },
  "credit_agencies": {
    "accounts": 0,
    "lenders": 0
  },
  "death_register": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "date_of_death": "string",
      "date_of_registration": "string",
      "district": "string",
      "dob": "string",
      "first_name": "string",
      "gro_reference": "string",
      "last_name": "string",
      "match_type": "string",
      "middle_name": "string",
      "mothers_maiden_name": "string",
      "place_of_birth": "string"
    }
  ],
  "dob": "yyyy-mm-dd",
  "dob_validated": 0,
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "mpan_result": true,
  "phone_match": [
    "string"
  ]
}

AddressData

Properties

Name Type Required Restrictions Description
address_detail AddressDetails false none none
address_type string false none Address type. Possible values are: current, previous
bank_account BankAccount false none none
credit_agencies CreditAgency false none none
death_register [DeathRegister] false none Top level data field for death register details
dob string false none DateOfBirth the address has been matched to
dob_validated integer(int32) false none Shows the number of times the DOB has been confirmed
first_name string false none Forename that the address has been matched to
last_name string false none Lastname that the address has been matched to
middle_name string false none Middlename that the address has been matched to
mpan_result boolean false none Returns true if the MPAN number is valid
phone_match [string] false none A list of telephone numbers that are associated with the subject

Enumerated Values

Property Value
address_type current
address_type previous

AddressDetails

{
  "match_sources": [
    {
      "source": "string",
      "year": "string"
    }
  ],
  "occupants": [
    {
      "dob": "yyyy-mm-dd",
      "match_sources": [
        {
          "source": "string",
          "year": "string"
        }
      ],
      "name": "string",
      "phone_number": "string",
      "recency": "yyyy-mm-dd",
      "residency": "string"
    }
  ],
  "property": {
    "matches": [
      {
        "match_type": "string",
        "ownership_type": "joint_ownership",
        "title_number": "string"
      }
    ],
    "sale_date": "string",
    "sale_price": "string",
    "tenure": "freehold",
    "type": "terrace"
  }
}

AddressDetails

Properties

Name Type Required Restrictions Description
match_sources [MatchSource] false none Top level data field for address match sources
occupants [Occupant] false none Top level data field for occupants at the address
property Property false none none

Alias

{
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string"
}

Alias

Properties

Name Type Required Restrictions Description
first_name string false none Alternative first name for the matched person
last_name string false none Alternative last name for the matched person
middle_name string false none Alternative middle name for the matched person

AllProviderData

{
  "company_data": {
    "appointment": {
      "current_directors": [
        {
          "address_data": "string",
          "dob": "string",
          "gender": "Male",
          "name": "string",
          "position": [
            {
              "appointed_date": "string",
              "role": "string"
            }
          ]
        }
      ],
      "previous_directors": [
        {
          "address_data": "string",
          "dob": "string",
          "gender": "Male",
          "name": "string",
          "position": [
            {
              "appointed_date": "string",
              "role": "string"
            }
          ]
        }
      ]
    },
    "contact_address": {
      "email": [
        "string"
      ],
      "main_address": {
        "address_data": "string",
        "telephone": "string"
      },
      "other_addresses": [
        {
          "address_data": "string",
          "telephone": "string"
        }
      ],
      "previous_addresses": [
        {
          "address_data": "string"
        }
      ],
      "website": [
        "string"
      ]
    },
    "credit_score": {
      "current_contract_limit": "string",
      "current_credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      },
      "previous_credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      }
    },
    "financial": [
      {
        "balance_sheet": {
          "bank_liabilities": "string",
          "bank_liabilities_due_after_1_year": "string",
          "called_up_share_capital": "string",
          "cash": "string",
          "finished_goods": "string",
          "goodwill": "string",
          "group_payables": "string",
          "group_payables_due_after_1_year": "string",
          "group_receivables": "string",
          "investments": "string",
          "land_and_buildings": "string",
          "loans_to_group": "string",
          "miscellaneous_fixed_assets": "string",
          "miscellaneous_liabilities": "string",
          "miscellaneous_liabilities_due_after_1_year": "string",
          "miscellaneous_receivables": "string",
          "other_current_assets": "string",
          "other_intangible_assets": "string",
          "other_inventories": "string",
          "other_loans": "string",
          "other_loans_or_finance": "string",
          "other_loans_or_finance_due_after_1_year": "string",
          "other_reserves": "string",
          "other_tangible_assets": "string",
          "plant_and_machinery": "string",
          "raw_materials": "string",
          "receivables_due_after_1_year": "string",
          "revenue_reserves": "string",
          "share_premium": "string",
          "total_assets": "string",
          "total_current_assets": "string",
          "total_current_liabilities": "string",
          "total_fixed_assets": "string",
          "total_intangible_assets": "string",
          "total_inventories": "string",
          "total_liabilities": "string",
          "total_long_term_liabilities": "string",
          "total_other_fixed_assets": "string",
          "total_receivables": "string",
          "total_shareholders_equity": "string",
          "total_tangible_assets": "string",
          "trade_payables": "string",
          "trade_payables_due_after_1_year": "string",
          "trade_receivables": "string",
          "work_in_progress": "string"
        },
        "currency": "string",
        "is_consolidated_accounts": true,
        "number_of_weeks": "string",
        "other_financials": {
          "contingent_liabilities": "string",
          "net_worth": "string",
          "working_capital": "string"
        },
        "profit_and_loss": {
          "amortisation": "string",
          "depreciation": "string",
          "dividends": "string",
          "extraordinary_costs": "string",
          "extraordinary_income": "string",
          "financial_expenses": "string",
          "financial_income": "string",
          "minority_interests": "string",
          "operating_costs": "string",
          "operating_profit": "string",
          "other_appropriations": "string",
          "pension_costs": "string",
          "profit_after_tax": "string",
          "profit_before_tax": "string",
          "retained_profit": "string",
          "revenue": "string",
          "tax": "string",
          "wages_and_salaries": "string"
        },
        "ratios": {
          "creditor_days": "string",
          "current_debt_ratio": "string",
          "current_ratio": "string",
          "debtor_days": "string",
          "equity_in_percentage": "string",
          "gearing": "string",
          "liquidity_ratio_or_acid_test": "string",
          "pre_tax_profit_margin": "string",
          "return_on_captial_employed": "string",
          "return_on_net_assets_employed": "string",
          "return_on_total_assets_employed": "string",
          "sales_or_net_working_capital": "string",
          "stock_turnover_ratio": "string",
          "total_debt_ratio": "string"
        },
        "year_end_date": "string"
      }
    ],
    "general_information": {
      "VAT": {
        "registration_date": "string",
        "registration_number": "string"
      },
      "activities": [
        {
          "code": "string",
          "description": "string"
        }
      ],
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "business_name": "string",
      "credit_rating": {
        "credit_limit": "string",
        "description": "string",
        "rating": "string"
      },
      "date_of_registration": "string",
      "date_of_starting_operations": "string",
      "latest_shareholders_equity": "string",
      "latest_turnover": "string",
      "legal_form": "string",
      "phone_number": "string",
      "previous_names": [
        {
          "date_changed": "string",
          "name": "string"
        }
      ],
      "registered_company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type_of_ownership": "string"
    },
    "group_structure": {
      "affiliated_companies": [
        {
          "address_data": "string",
          "company_name": "string",
          "registration_number": "string",
          "status": "string",
          "type": "string",
          "vat_number": "string"
        }
      ],
      "immediate_parent": {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      },
      "subsidiary_companies": [
        {
          "address_data": "string",
          "company_name": "string",
          "registration_number": "string",
          "status": "string",
          "type": "string",
          "vat_number": "string"
        }
      ],
      "ultimate_parent": {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      }
    },
    "lei": {
      "lei_number": "string"
    },
    "peps_and_sanctions": [
      {
        "address": [
          {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          }
        ],
        "aliases": [
          {
            "first_name": "string",
            "last_name": "string",
            "middle_name": "string"
          }
        ],
        "articles": [
          {
            "categories": [
              "string"
            ],
            "date_collected": "string",
            "original_url": "string",
            "provider_url": "string",
            "snippet": {
              "keywords_matched": [
                "string"
              ],
              "summary": "string",
              "title": "string"
            }
          }
        ],
        "business_name": "string",
        "fax_number": "string",
        "is_adverse_media": true,
        "is_disqualified_director": true,
        "is_financial_regulator": true,
        "is_insolvent": true,
        "is_law_enforcement": true,
        "is_pep": true,
        "is_sanctions_current": true,
        "is_sanctions_previous": true,
        "linked_businesses": [
          {
            "business_name": "string",
            "position": "string"
          }
        ],
        "linked_persons": [
          {
            "association": "string",
            "name": "string"
          }
        ],
        "notes": [
          {
            "data_source": "string",
            "snippet": [
              {
                "keywords_matched": [
                  "string"
                ],
                "summary": "string",
                "title": "string"
              }
            ],
            "text": "string"
          }
        ],
        "sanctions": [
          {
            "is_current": true,
            "sanction_type": "string"
          }
        ],
        "score": 0,
        "telephone_number": "string",
        "website": "string"
      }
    ],
    "persons_with_significant_control": [
      {
        "address": {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        },
        "country_of_residence": "string",
        "dob": {
          "month": "string",
          "year": "string"
        },
        "identification": {
          "country_registered": "string",
          "legal_authority": "string",
          "legal_form": "string",
          "place_registered": "string",
          "registration_number": "string"
        },
        "name": "string",
        "nationality": "string",
        "natures_of_control": [
          "string"
        ],
        "notified_on": "string",
        "type": "INDIVIDUAL"
      }
    ],
    "shareholder_information": {
      "issued_share_capital": "string",
      "nominal_share_capital": "string",
      "shareholders": [
        {
          "address_data": "string",
          "name": "string",
          "share_percent": "string"
        }
      ]
    },
    "ultimate_beneficial_owner": {
      "resolution": {
        "code": "string",
        "description": "string"
      },
      "search_level_details": [
        {
          "beneficial_owners": [
            {
              "name": "string",
              "owner_type": "string",
              "reason": "string"
            }
          ],
          "company_name": "string",
          "company_registration_number": "string",
          "country": "string",
          "search_level": 0
        }
      ]
    }
  },
  "person_data": [
    {
      "address": [
        {
          "address_detail": {
            "match_sources": [
              {
                "source": "string",
                "year": "string"
              }
            ],
            "occupants": [
              {
                "dob": "yyyy-mm-dd",
                "match_sources": [
                  {
                    "source": "string",
                    "year": "string"
                  }
                ],
                "name": "string",
                "phone_number": "string",
                "recency": "yyyy-mm-dd",
                "residency": "string"
              }
            ],
            "property": {
              "matches": [
                {
                  "match_type": "string",
                  "ownership_type": "joint_ownership",
                  "title_number": "string"
                }
              ],
              "sale_date": "string",
              "sale_price": "string",
              "tenure": "freehold",
              "type": "terrace"
            }
          },
          "address_type": "current",
          "bank_account": {
            "account": {
              "account_address_match": true,
              "account_name_match": true,
              "account_number_match": true,
              "account_status": "no_match",
              "sortcode_match": true
            },
            "bank": {
              "account_valid": true,
              "bank_name": "string",
              "branch_name": "string"
            }
          },
          "credit_agencies": {
            "accounts": 0,
            "lenders": 0
          },
          "death_register": [
            {
              "address": {
                "address_line1": "string",
                "address_line2": "string",
                "address_line3": "string",
                "address_line4": "string",
                "address_line5": "string",
                "country": "string",
                "postcode": "string"
              },
              "date_of_death": "string",
              "date_of_registration": "string",
              "district": "string",
              "dob": "string",
              "first_name": "string",
              "gro_reference": "string",
              "last_name": "string",
              "match_type": "string",
              "middle_name": "string",
              "mothers_maiden_name": "string",
              "place_of_birth": "string"
            }
          ],
          "dob": "yyyy-mm-dd",
          "dob_validated": 0,
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "mpan_result": true,
          "phone_match": [
            "string"
          ]
        }
      ],
      "court_judgement": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "amount": "string",
          "case_number": "string",
          "court_name": "string",
          "dob": "string",
          "end_date": "string",
          "issued_date": "string",
          "name": "string",
          "type": "string"
        }
      ],
      "documents": [
        {
          "check_uuid": "string",
          "country_code": "string",
          "date_of_birth": "string",
          "document_description": "string",
          "document_number": "string",
          "document_uuid": "string",
          "error_msg": "string",
          "expiry_date": "string",
          "first_name": "string",
          "gender": "string",
          "has_document_report": true,
          "id_type": "string",
          "is_expired": true,
          "is_mrz_validated": true,
          "last_name": "string",
          "mrz_line_1": "string",
          "mrz_line_2": "string",
          "mrz_line_3": "string",
          "nationality": "string",
          "notes": [
            "string"
          ],
          "personal_number": "string",
          "provider": "string",
          "providers_used": [
            "string"
          ],
          "status": "CHECKED_PASSED",
          "supplier_guid": "string"
        }
      ],
      "insolvencies": [
        {
          "address": [
            {
              "address_line1": "string",
              "address_line2": "string",
              "address_line3": "string",
              "address_line4": "string",
              "address_line5": "string",
              "country": "string",
              "postcode": "string"
            }
          ],
          "aliases": [
            "string"
          ],
          "asset_total": 0,
          "case_description": "string",
          "case_number": "string",
          "case_type": "string",
          "court": "string",
          "debt_total": 0,
          "dob": "string",
          "name": "string",
          "occupation": "string",
          "presentation_date": "string",
          "service_office": "string",
          "start_date": "string",
          "status": "string",
          "trading_name": "string",
          "type": "string"
        }
      ],
      "officer_directorships": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "address_line6": "string",
            "country": "string",
            "postcode": "string"
          },
          "directorships": [
            {
              "appointed_date": "string",
              "company_name": "string",
              "company_number": "string",
              "company_status": "string",
              "position": "string",
              "resignation_date": "string",
              "type": "string"
            }
          ],
          "dob": "string",
          "name": "string",
          "nationality": "string"
        }
      ],
      "officer_disqualifications": [
        {
          "company_number": "string",
          "country_of_registration": "string",
          "disqualifications": [
            {
              "address": {
                "address_line1": "string",
                "address_line2": "string",
                "address_line3": "string",
                "address_line4": "string",
                "address_line5": "string",
                "country": "string",
                "postcode": "string"
              },
              "company_names": [
                "string"
              ],
              "disqualification_type": "string",
              "end_date": "string",
              "reason": {
                "act": "string",
                "article": "string",
                "description_identifier": "string",
                "section": "string"
              },
              "start_date": "string"
            }
          ],
          "dob": "string",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string"
        }
      ],
      "peps_and_sanctions": [
        {
          "address": [
            {
              "address_line1": "string",
              "address_line2": "string",
              "address_line3": "string",
              "address_line4": "string",
              "address_line5": "string",
              "country": "string",
              "postcode": "string"
            }
          ],
          "aliases": [
            {
              "first_name": "string",
              "last_name": "string",
              "middle_name": "string"
            }
          ],
          "articles": [
            {
              "categories": [
                "string"
              ],
              "date_collected": "string",
              "original_url": "string",
              "provider_url": "string",
              "snippet": {
                "keywords_matched": [
                  "string"
                ],
                "summary": "string",
                "title": "string"
              }
            }
          ],
          "dob": "string",
          "dod": "string",
          "email": "string",
          "first_name": "string",
          "gender": "string",
          "image_url": "string",
          "is_adverse_media": true,
          "is_deceased": true,
          "is_disqualified_director": true,
          "is_financial_regulator": true,
          "is_insolvent": true,
          "is_law_enforcement": true,
          "is_pep": true,
          "is_sanctions_current": true,
          "is_sanctions_previous": true,
          "last_name": "string",
          "linked_businesses": [
            {
              "business_name": "string",
              "position": "string"
            }
          ],
          "linked_persons": [
            {
              "association": "string",
              "name": "string"
            }
          ],
          "middle_name": "string",
          "mobile_number": "string",
          "nationality": "string",
          "notes": [
            {
              "data_source": "string",
              "snippet": [
                {
                  "keywords_matched": [
                    "string"
                  ],
                  "summary": "string",
                  "title": "string"
                }
              ],
              "text": "string"
            }
          ],
          "pep_level": "string",
          "political_positions": [
            {
              "country": "string",
              "description": "string",
              "end_date": "string",
              "start_date": "string"
            }
          ],
          "sanctions": [
            {
              "is_current": true,
              "sanction_type": "string"
            }
          ],
          "score": "string",
          "telephone_number": "string",
          "year_of_birth": "string",
          "year_of_death": "string"
        }
      ],
      "person_index": 0,
      "social": {
        "age": "string",
        "education": [
          {
            "degree": "string",
            "name": "string",
            "year": 0
          }
        ],
        "email": "string",
        "employment": [
          {
            "current": true,
            "name": "string",
            "title": "string"
          }
        ],
        "first_name": "string",
        "gender": "string",
        "last_name": "string",
        "locations": [
          {
            "city": "string",
            "country": "string",
            "region": "string"
          }
        ],
        "photos": [
          {
            "label": "string",
            "url": "string"
          }
        ],
        "profiles": [
          {
            "bio": "string",
            "name": "string",
            "url": "string"
          }
        ]
      }
    }
  ]
}

AllProviderData

Properties

Name Type Required Restrictions Description
company_data CombinedCompanyData false none none
person_data [CombinedPersonData] false none Top level data field for person

ApiErrorDetailResponse

{
  "field": "string",
  "message": "string"
}

ApiErrorDetailResponse

Properties

Name Type Required Restrictions Description
field string false none Field that has gone wrong
message string false none Detail message for the error

ApiErrorResponse

{
  "code": "string",
  "error": "string",
  "errorDetail": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "path": "string",
  "status": 0,
  "timestamp": "string"
}

ApiErrorResponse

Properties

Name Type Required Restrictions Description
code string false none This will contain the Northrow error code. Reserved for future releases.
error string false none HTTP Reason for the error
errorDetail [ApiErrorDetailResponse] false none Detail for the error
path string false none The endpoint that has failed
status integer(int32) false none HTTP Status code
timestamp string false none Timestamp for the error

AppointmentData

{
  "current_directors": [
    {
      "address_data": "string",
      "dob": "string",
      "gender": "Male",
      "name": "string",
      "position": [
        {
          "appointed_date": "string",
          "role": "string"
        }
      ]
    }
  ],
  "previous_directors": [
    {
      "address_data": "string",
      "dob": "string",
      "gender": "Male",
      "name": "string",
      "position": [
        {
          "appointed_date": "string",
          "role": "string"
        }
      ]
    }
  ]
}

AppointmentData

Properties

Name Type Required Restrictions Description
current_directors [CurrentDirector] false none Top level data field for current directors
previous_directors [PreviousDirector] false none Top level data field for previous directors

Article

{
  "categories": [
    "string"
  ],
  "date_collected": "string",
  "original_url": "string",
  "provider_url": "string",
  "snippet": {
    "keywords_matched": [
      "string"
    ],
    "summary": "string",
    "title": "string"
  }
}

Article

Properties

Name Type Required Restrictions Description
categories [string] false none Array of categories for the article
date_collected string false none Date the article was collected by our provider
original_url string false none Link to original website
provider_url string false none Link to the pdf format of the article
snippet Snippet false none none

AuthoriseRequest

{
  "organisation_uid": "string",
  "access_key": "string"
}

AuthoriseRequest

Properties

Name Type Required Restrictions Description
organisation_uid string true none Organisation UID of the user's organisation
access_key string true none Access Key for the user

AuthorisedResponse

{
  "token": "string"
}

AuthorisedResponse

Properties

Name Type Required Restrictions Description
token string false none none

Back

{
  "data": "string",
  "name": "string"
}

Back

Properties

Name Type Required Restrictions Description
data string false none The image data of the back side of the uploaded document in Base64 format. The original file cannot exceed 4MB.
name string false none The name of the back side of the uploaded document with the extension

BalanceSheet

{
  "bank_liabilities": "string",
  "bank_liabilities_due_after_1_year": "string",
  "called_up_share_capital": "string",
  "cash": "string",
  "finished_goods": "string",
  "goodwill": "string",
  "group_payables": "string",
  "group_payables_due_after_1_year": "string",
  "group_receivables": "string",
  "investments": "string",
  "land_and_buildings": "string",
  "loans_to_group": "string",
  "miscellaneous_fixed_assets": "string",
  "miscellaneous_liabilities": "string",
  "miscellaneous_liabilities_due_after_1_year": "string",
  "miscellaneous_receivables": "string",
  "other_current_assets": "string",
  "other_intangible_assets": "string",
  "other_inventories": "string",
  "other_loans": "string",
  "other_loans_or_finance": "string",
  "other_loans_or_finance_due_after_1_year": "string",
  "other_reserves": "string",
  "other_tangible_assets": "string",
  "plant_and_machinery": "string",
  "raw_materials": "string",
  "receivables_due_after_1_year": "string",
  "revenue_reserves": "string",
  "share_premium": "string",
  "total_assets": "string",
  "total_current_assets": "string",
  "total_current_liabilities": "string",
  "total_fixed_assets": "string",
  "total_intangible_assets": "string",
  "total_inventories": "string",
  "total_liabilities": "string",
  "total_long_term_liabilities": "string",
  "total_other_fixed_assets": "string",
  "total_receivables": "string",
  "total_shareholders_equity": "string",
  "total_tangible_assets": "string",
  "trade_payables": "string",
  "trade_payables_due_after_1_year": "string",
  "trade_receivables": "string",
  "work_in_progress": "string"
}

BalanceSheet

Properties

Name Type Required Restrictions Description
bank_liabilities string false none Amount due within one year owing to banks for overdrafts and loans
bank_liabilities_due_after_1_year string false none Amount due after one year owing to banks for overdrafts and loans
called_up_share_capital string false none The issued and paid share capital from shareholders
cash string false none Cash at bank, cash in hand and cash equivalents
finished_goods string false none Goods held that are ready for sale or use
goodwill string false none The premium paid or accumulated on the purchase of an asset
group_payables string false none Amounts due within one year to related businesses
group_payables_due_after_1_year string false none Amounts due after one year to related businesses
group_receivables string false none Amounts due within one year from related businesses
investments string false none Long term investments including shares and securities
land_and_buildings string false none Land and buildings owned by the company for long term use
loans_to_group string false none Long term loans made by the company to related businesses
miscellaneous_fixed_assets string false none Long term assets other than Tangible Assets, Intangible Assets, Investments or Loans
miscellaneous_liabilities string false none Other amounts due within one year owing by the company
miscellaneous_liabilities_due_after_1_year string false none Other amounts due after one year owing by the company
miscellaneous_receivables string false none Amounts due within one year owing to the company other than trade and group receivables
other_current_assets string false none Any short term assets that have not already been included as Inventory, Receivables or Cash
other_intangible_assets string false none Intangible fixed assets other than goodwill such as Trade Marks, Patents, Research and Development etc
other_inventories string false none Other amounts classed as Inventory but not included above
other_loans string false none Other long term loans made by the company
other_loans_or_finance string false none Loans or finance due within one year owing to parties other than banks or related businesses
other_loans_or_finance_due_after_1_year string false none Loans or finance due after one year owing to parties other than banks or related businesses
other_reserves string false none Other capital and reserves that form part of shareholders equity
other_tangible_assets string false none Tangible fixed assets other than Land & Buildings or Plant and Machinery
plant_and_machinery string false none Plant and machinery owned by the company for long term use
raw_materials string false none Materials held by the company that have not yet been processed
receivables_due_after_1_year string false none Amounts due after one year owing to the company (including trade and group receivables due after one year)
revenue_reserves string false none The accumulation of profits/losses from previous trading periods
share_premium string false none The excess of the amount received on the issue of shares over their value
total_assets string false none The total of Current and Fixed Assets
total_current_assets string false none The total of Stocks, Debtors, Cash and other assets due within one year
total_current_liabilities string false none Total short term liabilities of the company
total_fixed_assets string false none The total of Tangible and Intangible Assets
total_intangible_assets string false none Assets that have a value but no physical existence
total_inventories string false none The total of stocks held by the company and work in progress
total_liabilities string false none The total of Total Long Term Liabilities and Total Current Liabilities
total_long_term_liabilities string false none Total long term liabilities of the company
total_other_fixed_assets string false none Total long term assets other than Tangible Assets or Intangible Assets
total_receivables string false none Total amounts receivable by the company
total_shareholders_equity string false none The total capital and reserves of the company
total_tangible_assets string false none Physical assets owned by the company for long term use
trade_payables string false none Amount due within one year owing to suppliers for goods and services provided on credit
trade_payables_due_after_1_year string false none Amount due after one year owing to suppliers for goods and services provided on credit
trade_receivables string false none Amounts due within one year from customers for goods and services supplied on credit
work_in_progress string false none Goods held that are ready for sale or use

Bank

{
  "account_valid": true,
  "bank_name": "string",
  "branch_name": "string"
}

Bank

Properties

Name Type Required Restrictions Description
account_valid boolean false none Returns true if bank account is valid
bank_name string false none Displays name of the bank
branch_name string false none Displays the name of the branch

BankAccount

{
  "account": {
    "account_address_match": true,
    "account_name_match": true,
    "account_number_match": true,
    "account_status": "no_match",
    "sortcode_match": true
  },
  "bank": {
    "account_valid": true,
    "bank_name": "string",
    "branch_name": "string"
  }
}

BankAccount

Properties

Name Type Required Restrictions Description
account BankAccountDetails false none none
bank Bank false none none

BankAccountDetails

{
  "account_address_match": true,
  "account_name_match": true,
  "account_number_match": true,
  "account_status": "no_match",
  "sortcode_match": true
}

BankAccountDetails

Properties

Name Type Required Restrictions Description
account_address_match boolean false none Confirms whether the account address matches for the person
account_name_match boolean false none Confirms whether the account name matches for the person
account_number_match boolean false none Confirms whether the account number is valid for the person
account_status string false none Confirms the current status of the account. Possible values are: live, settled, closed, no_match
sortcode_match boolean false none Confirms whether the sortcode is valid for the person

Enumerated Values

Property Value
account_status no_match
account_status live
account_status settled
account_status closed

BasicAddressDetails

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

BasicAddressDetails

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address for death found
address_line2 string false none The second line of the address for death found
address_line3 string false none The third line of the address for death found
address_line4 string false none The fourth line of the address for death found
address_line5 string false none The fifth line of the address for death found
country string false none The country of the address for death found
postcode string false none The postcode of the address for death found

BeneficialOwner

{
  "name": "string",
  "owner_type": "string",
  "reason": "string"
}

BeneficialOwner

Properties

Name Type Required Restrictions Description
name string false none The name of the Beneficial Owner
owner_type string false none The type of ownership. Possible values are: ULTIMATE_BENEFICIAL_OWNER, BENEFICIAL_OWNER_PSC_TLC, BENEFICIAL_OWNER_FOR_IC, BENEFICIAL_OWNER_PSC_IC
reason string false none A text that describes the ownership

CheckAddDocumentRequest

{
  "data": "string",
  "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
  "name": "string"
}

CheckAddDocumentRequest

Properties

Name Type Required Restrictions Description
data string false none The image data of the front side of the uploaded document in Base64 format. The original file cannot exceed 4MB.
mime_type string false none The mime_type of the uploaded document. Accepted values are: image/jpeg, image/bmp, image/png, application/pdf, image/tiff
name string false none The name of the front side of the uploaded document with the extension

CheckAlert

{
  "category": "Person,Company,ID,Other,Risk",
  "crid": "string",
  "message": "string",
  "score": 0,
  "type": "alert, info, verification"
}

CheckAlert

Properties

Name Type Required Restrictions Description
category string false none Category of the alert. Valid values are: Person,Company,ID,Other,Risk
crid string false none Unique NorthRow rule ID of the alert
message string false none Description of the alert
score integer(int32) false none Score of the alert
type string false none Type of the alert. Valid values are: alert, info, verification

CheckCompanyRequest

{
  "company": {
    "description": "string",
    "name": "string",
    "phone": {
      "number": "string",
      "type": "mobile,landline"
    },
    "registered": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "registration_number": "string",
    "tax_number": "string",
    "trading": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "type": "string",
    "vat_number": "string",
    "website": "string"
  },
  "contacts": [
    {
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "current_address": {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      },
      "date_of_birth": "yyyy-mm-dd",
      "documents": [
        {
          "back": {
            "data": "string",
            "name": "string"
          },
          "document_uuid": "string",
          "front": {
            "data": "string",
            "name": "string"
          },
          "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "email_address": [
        "string"
      ],
      "first_name": "string",
      "gender": "male, female",
      "identification_details": [
        {
          "issuing_country": "string",
          "number": "string",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "last_name": "string",
      "middle_name": "string",
      "mpan": "string",
      "phone": [
        {
          "number": "string",
          "type": "mobile,landline"
        }
      ],
      "previous_address": [
        {
          "country": "'GB' is the country code for United Kingdom",
          "county": "string",
          "line_five": "string",
          "line_four": "string",
          "line_six": "string",
          "line_three": "string",
          "name_number": "string",
          "postcode": "string",
          "state": "string",
          "street": "string",
          "town": "string"
        }
      ],
      "title": "mr,mrs"
    }
  ],
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  }
}

CheckCompanyRequest

Properties

Name Type Required Restrictions Description
company Company false none none
contacts [Person] false none Company contact details for the check
custom_data [CustomData] false none Custom section for the check
header Header false none none

CheckCompanyResponse

{
  "company": {
    "description": "string",
    "name": "string",
    "phone": {
      "number": "string",
      "type": "mobile,landline"
    },
    "registered": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "registration_number": "string",
    "tax_number": "string",
    "trading": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "type": "string",
    "vat_number": "string",
    "website": "string"
  },
  "contacts": [
    {
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "current_address": {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      },
      "date_of_birth": "yyyy-mm-dd",
      "documents": [
        {
          "back": {
            "data": "string",
            "name": "string"
          },
          "document_uuid": "string",
          "front": {
            "data": "string",
            "name": "string"
          },
          "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "email_address": [
        "string"
      ],
      "first_name": "string",
      "gender": "male, female",
      "identification_details": [
        {
          "issuing_country": "string",
          "number": "string",
          "type": "passport, driving_licence, residence_permit, visa, id_card"
        }
      ],
      "last_name": "string",
      "middle_name": "string",
      "mpan": "string",
      "phone": [
        {
          "number": "string",
          "type": "mobile,landline"
        }
      ],
      "previous_address": [
        {
          "country": "'GB' is the country code for United Kingdom",
          "county": "string",
          "line_five": "string",
          "line_four": "string",
          "line_six": "string",
          "line_three": "string",
          "name_number": "string",
          "postcode": "string",
          "state": "string",
          "street": "string",
          "town": "string"
        }
      ],
      "title": "mr,mrs"
    }
  ],
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  }
}

CheckCompanyResponse

Properties

Name Type Required Restrictions Description
company Company false none none
contacts [Person] false none Company contact details for the check
custom_data [CustomData] false none Custom section for the check
header Header false none none

CheckNoteRequest

{
  "note": "string"
}

CheckNoteRequest

Properties

Name Type Required Restrictions Description
note string true none Note that will be added to the check

CheckNotesResponse

{
  "added_date": "string",
  "note_content": "string",
  "user": "string"
}

CheckNotesResponse

Properties

Name Type Required Restrictions Description
added_date string false none The date the note was added
note_content string false none The text content of the note
user string false none The name of the user who added the note

CheckPersonRequest

{
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  },
  "person": {
    "bank_account": {
      "account": {
        "account_address_match": true,
        "account_name_match": true,
        "account_number_match": true,
        "account_status": "no_match",
        "sortcode_match": true
      },
      "bank": {
        "account_valid": true,
        "bank_name": "string",
        "branch_name": "string"
      }
    },
    "current_address": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "date_of_birth": "yyyy-mm-dd",
    "documents": [
      {
        "back": {
          "data": "string",
          "name": "string"
        },
        "document_uuid": "string",
        "front": {
          "data": "string",
          "name": "string"
        },
        "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "email_address": [
      "string"
    ],
    "first_name": "string",
    "gender": "male, female",
    "identification_details": [
      {
        "issuing_country": "string",
        "number": "string",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "last_name": "string",
    "middle_name": "string",
    "mpan": "string",
    "phone": [
      {
        "number": "string",
        "type": "mobile,landline"
      }
    ],
    "previous_address": [
      {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      }
    ],
    "title": "mr,mrs"
  }
}

CheckPersonRequest

Properties

Name Type Required Restrictions Description
custom_data [CustomData] false none Custom section for the check
header Header false none none
person Person false none none

CheckPersonResponse

{
  "custom_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "header": {
    "profile_uuid": "string",
    "remoteverify_enabled": true,
    "transaction_reference": "string"
  },
  "person": {
    "bank_account": {
      "account": {
        "account_address_match": true,
        "account_name_match": true,
        "account_number_match": true,
        "account_status": "no_match",
        "sortcode_match": true
      },
      "bank": {
        "account_valid": true,
        "bank_name": "string",
        "branch_name": "string"
      }
    },
    "current_address": {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    },
    "date_of_birth": "yyyy-mm-dd",
    "documents": [
      {
        "back": {
          "data": "string",
          "name": "string"
        },
        "document_uuid": "string",
        "front": {
          "data": "string",
          "name": "string"
        },
        "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "email_address": [
      "string"
    ],
    "first_name": "string",
    "gender": "male, female",
    "identification_details": [
      {
        "issuing_country": "string",
        "number": "string",
        "type": "passport, driving_licence, residence_permit, visa, id_card"
      }
    ],
    "last_name": "string",
    "middle_name": "string",
    "mpan": "string",
    "phone": [
      {
        "number": "string",
        "type": "mobile,landline"
      }
    ],
    "previous_address": [
      {
        "country": "'GB' is the country code for United Kingdom",
        "county": "string",
        "line_five": "string",
        "line_four": "string",
        "line_six": "string",
        "line_three": "string",
        "name_number": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "town": "string"
      }
    ],
    "title": "mr,mrs"
  }
}

CheckPersonResponse

Properties

Name Type Required Restrictions Description
custom_data [CustomData] false none Custom section for the check
header Header false none none
person Person false none none

CheckResponse

{
  "check_uuid": "string"
}

CheckResponse

Properties

Name Type Required Restrictions Description
check_uuid string false none CheckUuid if the check is submitted

CheckSummary

{
  "alerts": [
    {
      "category": "Person,Company,ID,Other,Risk",
      "crid": "string",
      "message": "string",
      "score": 0,
      "type": "alert, info, verification"
    }
  ],
  "category": "person, company",
  "center_location": "string",
  "client_name": "string",
  "company_name": "string",
  "date": "yyyy-MM-dd HH:mm:ss",
  "document_count": 0,
  "error_messages": [
    "string"
  ],
  "org_uid": "string",
  "profile": {
    "bio": "string",
    "name": "string",
    "url": "string"
  },
  "rag": "red, amber, green, waiting",
  "score": 0,
  "status": "live, archived",
  "suspicious": true,
  "transaction_reference": "string",
  "user": "string",
  "uuid": "string"
}

CheckSummary

Properties

Name Type Required Restrictions Description
alerts [CheckAlert] false none List of alerts for the check
category string false none Category of the check. Valid values are: person, company
center_location string false none Center location for the check if it was supplied in the initial request
client_name string false none Client name used in the check
company_name string false none Company name used in the check
date string false none Date when the check was submitted in yyyy-MM-dd HH:mm:ss format
document_count integer(int32) false none Number of documents included in the check
error_messages [string] false none Error messages if the check was not executed as expected
org_uid string false none Organisation uuid for the check
profile Profile false none none
rag string false none RAG for the check , if the check is incomplete a RAG of 'waiting' will be returned. Valid values are: red, amber, green, waiting
score integer(int32) false none Total score generated for the check
status string false none Status of the check. Valid values are: live: for active checks, archived: for archived checks
suspicious boolean false none Check marked as suspicious
transaction_reference string false none Reference used by the customer for the check
user string false none Username of the user who performed the check
uuid string false none Unique CheckUuid of the check

CheckSummaryResponse

{
  "limit": 0,
  "offset": 0,
  "results": [
    {
      "alerts": [
        {
          "category": "Person,Company,ID,Other,Risk",
          "crid": "string",
          "message": "string",
          "score": 0,
          "type": "alert, info, verification"
        }
      ],
      "category": "person, company",
      "center_location": "string",
      "client_name": "string",
      "company_name": "string",
      "date": "yyyy-MM-dd HH:mm:ss",
      "document_count": 0,
      "error_messages": [
        "string"
      ],
      "org_uid": "string",
      "profile": {
        "bio": "string",
        "name": "string",
        "url": "string"
      },
      "rag": "red, amber, green, waiting",
      "score": 0,
      "status": "live, archived",
      "suspicious": true,
      "transaction_reference": "string",
      "user": "string",
      "uuid": "string"
    }
  ],
  "sort_field": "string",
  "sort_order": "string",
  "total_records": 0
}

CheckSummaryResponse

Properties

Name Type Required Restrictions Description
limit integer(int32) false none Limit specified in the request is returned. If no limit (or) limit greater than maximum is provided in the request then it returns the default limit.
offset integer(int32) false none Number of records you wish to skip before selecting records
results [CheckSummary] false none List of CheckSummary
sort_field string false none Sorted field for the records returned
sort_order string false none Sorted order for the records returned
total_records integer(int64) false none Total number of checks returned that satisfies the criteria

CheckUpdate

{
  "archived_status": false,
  "note": "string",
  "rag": "red, amber, green"
}

CheckUpdate

Properties

Name Type Required Restrictions Description
archived_status boolean false none archived status for the check
note string true none Note for the check
rag string false none RAG for the check

CombinedCompanyData

{
  "appointment": {
    "current_directors": [
      {
        "address_data": "string",
        "dob": "string",
        "gender": "Male",
        "name": "string",
        "position": [
          {
            "appointed_date": "string",
            "role": "string"
          }
        ]
      }
    ],
    "previous_directors": [
      {
        "address_data": "string",
        "dob": "string",
        "gender": "Male",
        "name": "string",
        "position": [
          {
            "appointed_date": "string",
            "role": "string"
          }
        ]
      }
    ]
  },
  "contact_address": {
    "email": [
      "string"
    ],
    "main_address": {
      "address_data": "string",
      "telephone": "string"
    },
    "other_addresses": [
      {
        "address_data": "string",
        "telephone": "string"
      }
    ],
    "previous_addresses": [
      {
        "address_data": "string"
      }
    ],
    "website": [
      "string"
    ]
  },
  "credit_score": {
    "current_contract_limit": "string",
    "current_credit_rating": {
      "credit_limit": "string",
      "description": "string",
      "rating": "string"
    },
    "previous_credit_rating": {
      "credit_limit": "string",
      "description": "string",
      "rating": "string"
    }
  },
  "financial": [
    {
      "balance_sheet": {
        "bank_liabilities": "string",
        "bank_liabilities_due_after_1_year": "string",
        "called_up_share_capital": "string",
        "cash": "string",
        "finished_goods": "string",
        "goodwill": "string",
        "group_payables": "string",
        "group_payables_due_after_1_year": "string",
        "group_receivables": "string",
        "investments": "string",
        "land_and_buildings": "string",
        "loans_to_group": "string",
        "miscellaneous_fixed_assets": "string",
        "miscellaneous_liabilities": "string",
        "miscellaneous_liabilities_due_after_1_year": "string",
        "miscellaneous_receivables": "string",
        "other_current_assets": "string",
        "other_intangible_assets": "string",
        "other_inventories": "string",
        "other_loans": "string",
        "other_loans_or_finance": "string",
        "other_loans_or_finance_due_after_1_year": "string",
        "other_reserves": "string",
        "other_tangible_assets": "string",
        "plant_and_machinery": "string",
        "raw_materials": "string",
        "receivables_due_after_1_year": "string",
        "revenue_reserves": "string",
        "share_premium": "string",
        "total_assets": "string",
        "total_current_assets": "string",
        "total_current_liabilities": "string",
        "total_fixed_assets": "string",
        "total_intangible_assets": "string",
        "total_inventories": "string",
        "total_liabilities": "string",
        "total_long_term_liabilities": "string",
        "total_other_fixed_assets": "string",
        "total_receivables": "string",
        "total_shareholders_equity": "string",
        "total_tangible_assets": "string",
        "trade_payables": "string",
        "trade_payables_due_after_1_year": "string",
        "trade_receivables": "string",
        "work_in_progress": "string"
      },
      "currency": "string",
      "is_consolidated_accounts": true,
      "number_of_weeks": "string",
      "other_financials": {
        "contingent_liabilities": "string",
        "net_worth": "string",
        "working_capital": "string"
      },
      "profit_and_loss": {
        "amortisation": "string",
        "depreciation": "string",
        "dividends": "string",
        "extraordinary_costs": "string",
        "extraordinary_income": "string",
        "financial_expenses": "string",
        "financial_income": "string",
        "minority_interests": "string",
        "operating_costs": "string",
        "operating_profit": "string",
        "other_appropriations": "string",
        "pension_costs": "string",
        "profit_after_tax": "string",
        "profit_before_tax": "string",
        "retained_profit": "string",
        "revenue": "string",
        "tax": "string",
        "wages_and_salaries": "string"
      },
      "ratios": {
        "creditor_days": "string",
        "current_debt_ratio": "string",
        "current_ratio": "string",
        "debtor_days": "string",
        "equity_in_percentage": "string",
        "gearing": "string",
        "liquidity_ratio_or_acid_test": "string",
        "pre_tax_profit_margin": "string",
        "return_on_captial_employed": "string",
        "return_on_net_assets_employed": "string",
        "return_on_total_assets_employed": "string",
        "sales_or_net_working_capital": "string",
        "stock_turnover_ratio": "string",
        "total_debt_ratio": "string"
      },
      "year_end_date": "string"
    }
  ],
  "general_information": {
    "VAT": {
      "registration_date": "string",
      "registration_number": "string"
    },
    "activities": [
      {
        "code": "string",
        "description": "string"
      }
    ],
    "address": {
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "address_line4": "string",
      "address_line5": "string",
      "country": "string",
      "postcode": "string"
    },
    "business_name": "string",
    "credit_rating": {
      "credit_limit": "string",
      "description": "string",
      "rating": "string"
    },
    "date_of_registration": "string",
    "date_of_starting_operations": "string",
    "latest_shareholders_equity": "string",
    "latest_turnover": "string",
    "legal_form": "string",
    "phone_number": "string",
    "previous_names": [
      {
        "date_changed": "string",
        "name": "string"
      }
    ],
    "registered_company_name": "string",
    "registration_number": "string",
    "status": "string",
    "type_of_ownership": "string"
  },
  "group_structure": {
    "affiliated_companies": [
      {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      }
    ],
    "immediate_parent": {
      "address_data": "string",
      "company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type": "string",
      "vat_number": "string"
    },
    "subsidiary_companies": [
      {
        "address_data": "string",
        "company_name": "string",
        "registration_number": "string",
        "status": "string",
        "type": "string",
        "vat_number": "string"
      }
    ],
    "ultimate_parent": {
      "address_data": "string",
      "company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type": "string",
      "vat_number": "string"
    }
  },
  "lei": {
    "lei_number": "string"
  },
  "peps_and_sanctions": [
    {
      "address": [
        {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        }
      ],
      "aliases": [
        {
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string"
        }
      ],
      "articles": [
        {
          "categories": [
            "string"
          ],
          "date_collected": "string",
          "original_url": "string",
          "provider_url": "string",
          "snippet": {
            "keywords_matched": [
              "string"
            ],
            "summary": "string",
            "title": "string"
          }
        }
      ],
      "business_name": "string",
      "fax_number": "string",
      "is_adverse_media": true,
      "is_disqualified_director": true,
      "is_financial_regulator": true,
      "is_insolvent": true,
      "is_law_enforcement": true,
      "is_pep": true,
      "is_sanctions_current": true,
      "is_sanctions_previous": true,
      "linked_businesses": [
        {
          "business_name": "string",
          "position": "string"
        }
      ],
      "linked_persons": [
        {
          "association": "string",
          "name": "string"
        }
      ],
      "notes": [
        {
          "data_source": "string",
          "snippet": [
            {
              "keywords_matched": [
                "string"
              ],
              "summary": "string",
              "title": "string"
            }
          ],
          "text": "string"
        }
      ],
      "sanctions": [
        {
          "is_current": true,
          "sanction_type": "string"
        }
      ],
      "score": 0,
      "telephone_number": "string",
      "website": "string"
    }
  ],
  "persons_with_significant_control": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "country_of_residence": "string",
      "dob": {
        "month": "string",
        "year": "string"
      },
      "identification": {
        "country_registered": "string",
        "legal_authority": "string",
        "legal_form": "string",
        "place_registered": "string",
        "registration_number": "string"
      },
      "name": "string",
      "nationality": "string",
      "natures_of_control": [
        "string"
      ],
      "notified_on": "string",
      "type": "INDIVIDUAL"
    }
  ],
  "shareholder_information": {
    "issued_share_capital": "string",
    "nominal_share_capital": "string",
    "shareholders": [
      {
        "address_data": "string",
        "name": "string",
        "share_percent": "string"
      }
    ]
  },
  "ultimate_beneficial_owner": {
    "resolution": {
      "code": "string",
      "description": "string"
    },
    "search_level_details": [
      {
        "beneficial_owners": [
          {
            "name": "string",
            "owner_type": "string",
            "reason": "string"
          }
        ],
        "company_name": "string",
        "company_registration_number": "string",
        "country": "string",
        "search_level": 0
      }
    ]
  }
}

CombinedCompanyData

Properties

Name Type Required Restrictions Description
appointment AppointmentData false none none
contact_address ContactInformation false none none
credit_score CreditScoreData false none none
financial [CompanyFinancialData] false none Top level data field for company financials
general_information CompanyDetails false none none
group_structure CompanyGroupStructure false none none
lei LeiData false none none
peps_and_sanctions [CompanyData] false none Top level data field for pep and sanctions
persons_with_significant_control [PersonWithSignificantControl] false none Top level data field for the person with significant control
shareholder_information CompanyShareholders false none none
ultimate_beneficial_owner UBOData false none none

CombinedPersonData

{
  "address": [
    {
      "address_detail": {
        "match_sources": [
          {
            "source": "string",
            "year": "string"
          }
        ],
        "occupants": [
          {
            "dob": "yyyy-mm-dd",
            "match_sources": [
              {
                "source": "string",
                "year": "string"
              }
            ],
            "name": "string",
            "phone_number": "string",
            "recency": "yyyy-mm-dd",
            "residency": "string"
          }
        ],
        "property": {
          "matches": [
            {
              "match_type": "string",
              "ownership_type": "joint_ownership",
              "title_number": "string"
            }
          ],
          "sale_date": "string",
          "sale_price": "string",
          "tenure": "freehold",
          "type": "terrace"
        }
      },
      "address_type": "current",
      "bank_account": {
        "account": {
          "account_address_match": true,
          "account_name_match": true,
          "account_number_match": true,
          "account_status": "no_match",
          "sortcode_match": true
        },
        "bank": {
          "account_valid": true,
          "bank_name": "string",
          "branch_name": "string"
        }
      },
      "credit_agencies": {
        "accounts": 0,
        "lenders": 0
      },
      "death_register": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "date_of_death": "string",
          "date_of_registration": "string",
          "district": "string",
          "dob": "string",
          "first_name": "string",
          "gro_reference": "string",
          "last_name": "string",
          "match_type": "string",
          "middle_name": "string",
          "mothers_maiden_name": "string",
          "place_of_birth": "string"
        }
      ],
      "dob": "yyyy-mm-dd",
      "dob_validated": 0,
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "mpan_result": true,
      "phone_match": [
        "string"
      ]
    }
  ],
  "court_judgement": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "amount": "string",
      "case_number": "string",
      "court_name": "string",
      "dob": "string",
      "end_date": "string",
      "issued_date": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "documents": [
    {
      "check_uuid": "string",
      "country_code": "string",
      "date_of_birth": "string",
      "document_description": "string",
      "document_number": "string",
      "document_uuid": "string",
      "error_msg": "string",
      "expiry_date": "string",
      "first_name": "string",
      "gender": "string",
      "has_document_report": true,
      "id_type": "string",
      "is_expired": true,
      "is_mrz_validated": true,
      "last_name": "string",
      "mrz_line_1": "string",
      "mrz_line_2": "string",
      "mrz_line_3": "string",
      "nationality": "string",
      "notes": [
        "string"
      ],
      "personal_number": "string",
      "provider": "string",
      "providers_used": [
        "string"
      ],
      "status": "CHECKED_PASSED",
      "supplier_guid": "string"
    }
  ],
  "insolvencies": [
    {
      "address": [
        {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        }
      ],
      "aliases": [
        "string"
      ],
      "asset_total": 0,
      "case_description": "string",
      "case_number": "string",
      "case_type": "string",
      "court": "string",
      "debt_total": 0,
      "dob": "string",
      "name": "string",
      "occupation": "string",
      "presentation_date": "string",
      "service_office": "string",
      "start_date": "string",
      "status": "string",
      "trading_name": "string",
      "type": "string"
    }
  ],
  "officer_directorships": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "address_line6": "string",
        "country": "string",
        "postcode": "string"
      },
      "directorships": [
        {
          "appointed_date": "string",
          "company_name": "string",
          "company_number": "string",
          "company_status": "string",
          "position": "string",
          "resignation_date": "string",
          "type": "string"
        }
      ],
      "dob": "string",
      "name": "string",
      "nationality": "string"
    }
  ],
  "officer_disqualifications": [
    {
      "company_number": "string",
      "country_of_registration": "string",
      "disqualifications": [
        {
          "address": {
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string",
            "address_line4": "string",
            "address_line5": "string",
            "country": "string",
            "postcode": "string"
          },
          "company_names": [
            "string"
          ],
          "disqualification_type": "string",
          "end_date": "string",
          "reason": {
            "act": "string",
            "article": "string",
            "description_identifier": "string",
            "section": "string"
          },
          "start_date": "string"
        }
      ],
      "dob": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    }
  ],
  "peps_and_sanctions": [
    {
      "address": [
        {
          "address_line1": "string",
          "address_line2": "string",
          "address_line3": "string",
          "address_line4": "string",
          "address_line5": "string",
          "country": "string",
          "postcode": "string"
        }
      ],
      "aliases": [
        {
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string"
        }
      ],
      "articles": [
        {
          "categories": [
            "string"
          ],
          "date_collected": "string",
          "original_url": "string",
          "provider_url": "string",
          "snippet": {
            "keywords_matched": [
              "string"
            ],
            "summary": "string",
            "title": "string"
          }
        }
      ],
      "dob": "string",
      "dod": "string",
      "email": "string",
      "first_name": "string",
      "gender": "string",
      "image_url": "string",
      "is_adverse_media": true,
      "is_deceased": true,
      "is_disqualified_director": true,
      "is_financial_regulator": true,
      "is_insolvent": true,
      "is_law_enforcement": true,
      "is_pep": true,
      "is_sanctions_current": true,
      "is_sanctions_previous": true,
      "last_name": "string",
      "linked_businesses": [
        {
          "business_name": "string",
          "position": "string"
        }
      ],
      "linked_persons": [
        {
          "association": "string",
          "name": "string"
        }
      ],
      "middle_name": "string",
      "mobile_number": "string",
      "nationality": "string",
      "notes": [
        {
          "data_source": "string",
          "snippet": [
            {
              "keywords_matched": [
                "string"
              ],
              "summary": "string",
              "title": "string"
            }
          ],
          "text": "string"
        }
      ],
      "pep_level": "string",
      "political_positions": [
        {
          "country": "string",
          "description": "string",
          "end_date": "string",
          "start_date": "string"
        }
      ],
      "sanctions": [
        {
          "is_current": true,
          "sanction_type": "string"
        }
      ],
      "score": "string",
      "telephone_number": "string",
      "year_of_birth": "string",
      "year_of_death": "string"
    }
  ],
  "person_index": 0,
  "social": {
    "age": "string",
    "education": [
      {
        "degree": "string",
        "name": "string",
        "year": 0
      }
    ],
    "email": "string",
    "employment": [
      {
        "current": true,
        "name": "string",
        "title": "string"
      }
    ],
    "first_name": "string",
    "gender": "string",
    "last_name": "string",
    "locations": [
      {
        "city": "string",
        "country": "string",
        "region": "string"
      }
    ],
    "photos": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "profiles": [
      {
        "bio": "string",
        "name": "string",
        "url": "string"
      }
    ]
  }
}

CombinedPersonData

Properties

Name Type Required Restrictions Description
address [AddressData] false none Top level data field for person address
court_judgement [CourtJudgementData] false none Top level data field for person court judgement
documents [DocumentData] false none Top level data field for person documents
insolvencies [InsolvencyData] false none Top level data field for person insolvency
officer_directorships [OfficerData] false none Top level data field for officer directorships
officer_disqualifications [DisqualifiedOfficerData] false none Top level data field for officer disqualifications
peps_and_sanctions [PepAndSanctionDetails] false none Top level data field for person peps and sanctions
person_index integer(int32) false none Index for the person
social SocialData false none none

Company

{
  "description": "string",
  "name": "string",
  "phone": {
    "number": "string",
    "type": "mobile,landline"
  },
  "registered": {
    "country": "'GB' is the country code for United Kingdom",
    "county": "string",
    "line_five": "string",
    "line_four": "string",
    "line_six": "string",
    "line_three": "string",
    "name_number": "string",
    "postcode": "string",
    "state": "string",
    "street": "string",
    "town": "string"
  },
  "registration_number": "string",
  "tax_number": "string",
  "trading": {
    "country": "'GB' is the country code for United Kingdom",
    "county": "string",
    "line_five": "string",
    "line_four": "string",
    "line_six": "string",
    "line_three": "string",
    "name_number": "string",
    "postcode": "string",
    "state": "string",
    "street": "string",
    "town": "string"
  },
  "type": "string",
  "vat_number": "string",
  "website": "string"
}

Company

Properties

Name Type Required Restrictions Description
description string false none Description
name string true none Registered name
phone Phone false none none
registered Address_format_in_the_request false none none
registration_number string false none Registration number
tax_number string false none Tax number
trading Address_format_in_the_request false none none
type string false none Type
vat_number string false none Vat number
website string false none Website name

CompanyActivity

{
  "code": "string",
  "description": "string"
}

CompanyActivity

Properties

Name Type Required Restrictions Description
code string false none Main activity code used in that country
description string false none Description of main activity

CompanyAddress

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

CompanyAddress

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address for the company
address_line2 string false none The second line of the address for the company
address_line3 string false none The third line of the address for the company
address_line4 string false none The fourth line of the address for the company
address_line5 string false none The fifth line of the address for the company
country string false none The country of the address for the company
postcode string false none The postcode of the address for the company

CompanyCreditRating

{
  "credit_limit": "string",
  "description": "string",
  "rating": "string"
}

CompanyCreditRating

Properties

Name Type Required Restrictions Description
credit_limit string false none Amount of credit advisable at any one time
description string false none A text description of the common credit rating
rating string false none Credit score of the company

CompanyData

{
  "address": [
    {
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "address_line4": "string",
      "address_line5": "string",
      "country": "string",
      "postcode": "string"
    }
  ],
  "aliases": [
    {
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    }
  ],
  "articles": [
    {
      "categories": [
        "string"
      ],
      "date_collected": "string",
      "original_url": "string",
      "provider_url": "string",
      "snippet": {
        "keywords_matched": [
          "string"
        ],
        "summary": "string",
        "title": "string"
      }
    }
  ],
  "business_name": "string",
  "fax_number": "string",
  "is_adverse_media": true,
  "is_disqualified_director": true,
  "is_financial_regulator": true,
  "is_insolvent": true,
  "is_law_enforcement": true,
  "is_pep": true,
  "is_sanctions_current": true,
  "is_sanctions_previous": true,
  "linked_businesses": [
    {
      "business_name": "string",
      "position": "string"
    }
  ],
  "linked_persons": [
    {
      "association": "string",
      "name": "string"
    }
  ],
  "notes": [
    {
      "data_source": "string",
      "snippet": [
        {
          "keywords_matched": [
            "string"
          ],
          "summary": "string",
          "title": "string"
        }
      ],
      "text": "string"
    }
  ],
  "sanctions": [
    {
      "is_current": true,
      "sanction_type": "string"
    }
  ],
  "score": 0,
  "telephone_number": "string",
  "website": "string"
}

CompanyData

Properties

Name Type Required Restrictions Description
address [Address_in_the_company_data] false none Top level data field for addresses linked with the matched company
aliases [Alias] false none Top level data field for aliases of the matched company
articles [Article] false none Top level data field for articles linked with the matched company
business_name string false none Matched company name
fax_number string false none Matched companies fax number
is_adverse_media boolean false none Matched company belongs in adverse media dataset
is_disqualified_director boolean false none Matched company belongs in disqualified director dataset
is_financial_regulator boolean false none Matched company belongs in financial regulator dataset
is_insolvent boolean false none Matched company belongs in insolvency dataset
is_law_enforcement boolean false none Matched company belongs in law enforcement dataset
is_pep boolean false none Matched company is a PEP
is_sanctions_current boolean false none Matched company is currently sanctioned
is_sanctions_previous boolean false none Matched company was sanctioned in the past
linked_businesses [LinkedBusiness] false none Top level data field for businesses linked with matched company
linked_persons [LinkedPerson] false none Top level data field for persons linked with matched company
notes [Note] false none Top level data field for notes added to the matched company
sanctions [Sanction] false none Top level data field for sanctions of the matched company
score integer(int32) false none Matching score for matched company
telephone_number string false none Matched companies phone number
website string false none Matched companies website

CompanyDetails

{
  "VAT": {
    "registration_date": "string",
    "registration_number": "string"
  },
  "activities": [
    {
      "code": "string",
      "description": "string"
    }
  ],
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "country": "string",
    "postcode": "string"
  },
  "business_name": "string",
  "credit_rating": {
    "credit_limit": "string",
    "description": "string",
    "rating": "string"
  },
  "date_of_registration": "string",
  "date_of_starting_operations": "string",
  "latest_shareholders_equity": "string",
  "latest_turnover": "string",
  "legal_form": "string",
  "phone_number": "string",
  "previous_names": [
    {
      "date_changed": "string",
      "name": "string"
    }
  ],
  "registered_company_name": "string",
  "registration_number": "string",
  "status": "string",
  "type_of_ownership": "string"
}

CompanyDetails

Properties

Name Type Required Restrictions Description
VAT CompanyVAT false none none
activities [CompanyActivity] false none Top level data field for company activities
address CompanyAddress false none none
business_name string false none Registered company name/trading name of the company
credit_rating CompanyCreditRating false none none
date_of_registration string false none The date the company was registered
date_of_starting_operations string false none The date the company began trading
latest_shareholders_equity string false none The total of called up Share Capital, Revenue Reserves, Share Premium and Other Reserves
latest_turnover string false none Latest value for the previous year’s Net Sales
legal_form string false none The legal type of the company
phone_number string false none Registered telephone number
previous_names [PreviousCompanyName] false none Top level data field for company previous names
registered_company_name string false none Registered company name
registration_number string false none Official registration number
status string false none The high level status of the company. Possible values are: Active, NonActive, Pending and Other
type_of_ownership string false none The ownership of the company, whether wholly or part owned

CompanyFinancialData

{
  "balance_sheet": {
    "bank_liabilities": "string",
    "bank_liabilities_due_after_1_year": "string",
    "called_up_share_capital": "string",
    "cash": "string",
    "finished_goods": "string",
    "goodwill": "string",
    "group_payables": "string",
    "group_payables_due_after_1_year": "string",
    "group_receivables": "string",
    "investments": "string",
    "land_and_buildings": "string",
    "loans_to_group": "string",
    "miscellaneous_fixed_assets": "string",
    "miscellaneous_liabilities": "string",
    "miscellaneous_liabilities_due_after_1_year": "string",
    "miscellaneous_receivables": "string",
    "other_current_assets": "string",
    "other_intangible_assets": "string",
    "other_inventories": "string",
    "other_loans": "string",
    "other_loans_or_finance": "string",
    "other_loans_or_finance_due_after_1_year": "string",
    "other_reserves": "string",
    "other_tangible_assets": "string",
    "plant_and_machinery": "string",
    "raw_materials": "string",
    "receivables_due_after_1_year": "string",
    "revenue_reserves": "string",
    "share_premium": "string",
    "total_assets": "string",
    "total_current_assets": "string",
    "total_current_liabilities": "string",
    "total_fixed_assets": "string",
    "total_intangible_assets": "string",
    "total_inventories": "string",
    "total_liabilities": "string",
    "total_long_term_liabilities": "string",
    "total_other_fixed_assets": "string",
    "total_receivables": "string",
    "total_shareholders_equity": "string",
    "total_tangible_assets": "string",
    "trade_payables": "string",
    "trade_payables_due_after_1_year": "string",
    "trade_receivables": "string",
    "work_in_progress": "string"
  },
  "currency": "string",
  "is_consolidated_accounts": true,
  "number_of_weeks": "string",
  "other_financials": {
    "contingent_liabilities": "string",
    "net_worth": "string",
    "working_capital": "string"
  },
  "profit_and_loss": {
    "amortisation": "string",
    "depreciation": "string",
    "dividends": "string",
    "extraordinary_costs": "string",
    "extraordinary_income": "string",
    "financial_expenses": "string",
    "financial_income": "string",
    "minority_interests": "string",
    "operating_costs": "string",
    "operating_profit": "string",
    "other_appropriations": "string",
    "pension_costs": "string",
    "profit_after_tax": "string",
    "profit_before_tax": "string",
    "retained_profit": "string",
    "revenue": "string",
    "tax": "string",
    "wages_and_salaries": "string"
  },
  "ratios": {
    "creditor_days": "string",
    "current_debt_ratio": "string",
    "current_ratio": "string",
    "debtor_days": "string",
    "equity_in_percentage": "string",
    "gearing": "string",
    "liquidity_ratio_or_acid_test": "string",
    "pre_tax_profit_margin": "string",
    "return_on_captial_employed": "string",
    "return_on_net_assets_employed": "string",
    "return_on_total_assets_employed": "string",
    "sales_or_net_working_capital": "string",
    "stock_turnover_ratio": "string",
    "total_debt_ratio": "string"
  },
  "year_end_date": "string"
}

CompanyFinancialData

Properties

Name Type Required Restrictions Description
balance_sheet BalanceSheet false none none
currency string false none Currency the figures are displayed in
is_consolidated_accounts boolean false none Are the accounts consolidated. Possible values are : Y, N
number_of_weeks string false none Number of weeks in the year
other_financials OtherFinancials false none none
profit_and_loss ProfitAndLoss false none none
ratios Ratios false none none
year_end_date string false none Year to which the annual accounts relate to

CompanyGroupItem

{
  "address_data": "string",
  "company_name": "string",
  "registration_number": "string",
  "status": "string",
  "type": "string",
  "vat_number": "string"
}

CompanyGroupItem

Properties

Name Type Required Restrictions Description
address_data string false none The address as a String
company_name string false none Company Name
registration_number string false none Official registration number
status string false none The high level status of the company. Possible values are: Active, NonActive, Pending and Other
type string false none Determines whether a company is Limited(ltd)/Registered or NonLimited (nonltd)/Non Registered
vat_number string false none Local VAT Number

CompanyGroupStructure

{
  "affiliated_companies": [
    {
      "address_data": "string",
      "company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type": "string",
      "vat_number": "string"
    }
  ],
  "immediate_parent": {
    "address_data": "string",
    "company_name": "string",
    "registration_number": "string",
    "status": "string",
    "type": "string",
    "vat_number": "string"
  },
  "subsidiary_companies": [
    {
      "address_data": "string",
      "company_name": "string",
      "registration_number": "string",
      "status": "string",
      "type": "string",
      "vat_number": "string"
    }
  ],
  "ultimate_parent": {
    "address_data": "string",
    "company_name": "string",
    "registration_number": "string",
    "status": "string",
    "type": "string",
    "vat_number": "string"
  }
}

CompanyGroupStructure

Properties

Name Type Required Restrictions Description
affiliated_companies [CompanyGroupItem] false none Top level data field for affiliated companies
immediate_parent CompanyGroupItem false none none
subsidiary_companies [CompanyGroupItem] false none Top level data field for subsidary companies
ultimate_parent CompanyGroupItem false none none

CompanyShareholders

{
  "issued_share_capital": "string",
  "nominal_share_capital": "string",
  "shareholders": [
    {
      "address_data": "string",
      "name": "string",
      "share_percent": "string"
    }
  ]
}

CompanyShareholders

Properties

Name Type Required Restrictions Description
issued_share_capital string false none This is the issued and paid share capital from shareholders
nominal_share_capital string false none The maximum amount of share capital the company is authorised by its constitutional documents to issue to shareholders
shareholders [Shareholder] false none Top level data field for company shareholders

CompanyVAT

{
  "registration_date": "string",
  "registration_number": "string"
}

CompanyVAT

Properties

Name Type Required Restrictions Description
registration_date string false none Registration date of the local VAT number
registration_number string false none Local VAT Number

ContactInformation

{
  "email": [
    "string"
  ],
  "main_address": {
    "address_data": "string",
    "telephone": "string"
  },
  "other_addresses": [
    {
      "address_data": "string",
      "telephone": "string"
    }
  ],
  "previous_addresses": [
    {
      "address_data": "string"
    }
  ],
  "website": [
    "string"
  ]
}

ContactInformation

Properties

Name Type Required Restrictions Description
email [string] false none Email address for the company
main_address MainAddress false none none
other_addresses [OtherAddress] false none Top level data field for other company addresses
previous_addresses [PreviousAddress] false none Top level data field for previous company addresses
website [string] false none Website address of the company

CourtJudgementData

{
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "country": "string",
    "postcode": "string"
  },
  "amount": "string",
  "case_number": "string",
  "court_name": "string",
  "dob": "string",
  "end_date": "string",
  "issued_date": "string",
  "name": "string",
  "type": "string"
}

CourtJudgementData

Properties

Name Type Required Restrictions Description
address Address_in_the_court_judgement_data false none none
amount string false none Amount of the court judgement debt
case_number string false none Case number of the matched record
court_name string false none Name of the court where the court judgement was registered
dob string false none Date of birth of the person who is subject to the court judgement
end_date string false none Date the court judgement will end
issued_date string false none Date the court judgement was issued
name string false none Name of the person who is subject to the court judgement
type string false none Judgement type of the court judgement issued

CreditAgency

{
  "accounts": 0,
  "lenders": 0
}

CreditAgency

Properties

Name Type Required Restrictions Description
accounts integer(int32) false none Displays the number of accounts
lenders integer(int32) false none Displays the number of lenders

CreditScoreData

{
  "current_contract_limit": "string",
  "current_credit_rating": {
    "credit_limit": "string",
    "description": "string",
    "rating": "string"
  },
  "previous_credit_rating": {
    "credit_limit": "string",
    "description": "string",
    "rating": "string"
  }
}

CreditScoreData

Properties

Name Type Required Restrictions Description
current_contract_limit string false none A yardstick for the maximum contract capacity on a single contract over a 12-month period. This measurement views the applicant as a supplier of goods and services whereas a credit limit assesses the applicant as a purchaser
current_credit_rating CurrentCreditRating false none none
previous_credit_rating PreviousCreditRating false none none

CurrentCreditRating

{
  "credit_limit": "string",
  "description": "string",
  "rating": "string"
}

CurrentCreditRating

Properties

Name Type Required Restrictions Description
credit_limit string false none Amount of credit advisable at any one time
description string false none A text description of the common credit rating
rating string false none Standardised credit rating

CurrentDirector

{
  "address_data": "string",
  "dob": "string",
  "gender": "Male",
  "name": "string",
  "position": [
    {
      "appointed_date": "string",
      "role": "string"
    }
  ]
}

CurrentDirector

Properties

Name Type Required Restrictions Description
address_data string false none The address of the current director as a String
dob string false none The director's date of birth
gender string false none Gender. Possible values are: Male, Female
name string false none Full name of director
position [Position] false none Top level data field for director's position in the company

Enumerated Values

Property Value
gender Male
gender Female
gender Unknown

CustomData

{
  "key": "string",
  "value": "string"
}

CustomData

Properties

Name Type Required Restrictions Description
key string false none Key for the custom section
value string false none Value for the custom section

DeathRegister

{
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "country": "string",
    "postcode": "string"
  },
  "date_of_death": "string",
  "date_of_registration": "string",
  "district": "string",
  "dob": "string",
  "first_name": "string",
  "gro_reference": "string",
  "last_name": "string",
  "match_type": "string",
  "middle_name": "string",
  "mothers_maiden_name": "string",
  "place_of_birth": "string"
}

DeathRegister

Properties

Name Type Required Restrictions Description
address BasicAddressDetails false none none
date_of_death string false none Date of death of the person in the death record found
date_of_registration string false none Date of Registration of the death
district string false none District the death was registered in
dob string false none Date of birth of the person in the death record found
first_name string false none Firstname of the person in the death record found
gro_reference string false none GRO Reference number for the death found, used for deaths post 2007
last_name string false none Lastname of the person in the death record found
match_type string false none MatchType to show how the death record was matched
middle_name string false none Middlename of the person in the death record found
mothers_maiden_name string false none Mother's maiden name for the death found
place_of_birth string false none Place of Birth of the death found

Directorship

{
  "appointed_date": "string",
  "company_name": "string",
  "company_number": "string",
  "company_status": "string",
  "position": "string",
  "resignation_date": "string",
  "type": "string"
}

Directorship

Properties

Name Type Required Restrictions Description
appointed_date string false none The date the director was appointed to the position
company_name string false none The name of the company
company_number string false none The unique registered number of the company
company_status string false none The status of the company For example:Active, Dormant, Dissolved
position string false none The position held by the director. For example: chairman, director, secretary
resignation_date string false none The date the director resigned from the position
type string false none Type of the directorship. Possible values are: current, previous

DisqualificationDetail

{
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "country": "string",
    "postcode": "string"
  },
  "company_names": [
    "string"
  ],
  "disqualification_type": "string",
  "end_date": "string",
  "reason": {
    "act": "string",
    "article": "string",
    "description_identifier": "string",
    "section": "string"
  },
  "start_date": "string"
}

DisqualificationDetail

Properties

Name Type Required Restrictions Description
address Address_in_the_court_disqualified_officer_data false none none
company_names [string] false none The companies in which the misconduct took place
disqualification_type string false none Type of disqualification
end_date string false none The date that the disqualification ends
reason Reason false none none
start_date string false none The date that the disqualification starts

DisqualifiedOfficerData

{
  "company_number": "string",
  "country_of_registration": "string",
  "disqualifications": [
    {
      "address": {
        "address_line1": "string",
        "address_line2": "string",
        "address_line3": "string",
        "address_line4": "string",
        "address_line5": "string",
        "country": "string",
        "postcode": "string"
      },
      "company_names": [
        "string"
      ],
      "disqualification_type": "string",
      "end_date": "string",
      "reason": {
        "act": "string",
        "article": "string",
        "description_identifier": "string",
        "section": "string"
      },
      "start_date": "string"
    }
  ],
  "dob": "string",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string"
}

DisqualifiedOfficerData

Properties

Name Type Required Restrictions Description
company_number string false none The registration number of the disqualified officer
country_of_registration string false none The country in which the disqualified officer was registered
disqualifications [DisqualificationDetail] false none Top level data field for disqualification details
dob string false none The disqualified officer's date of birth
first_name string false none The first name of the disqualified officer
last_name string false none The last name of the disqualified officer
middle_name string false none The middle name of the disqualified officer

Dob

{
  "month": "string",
  "year": "string"
}

Dob

Properties

Name Type Required Restrictions Description
month string false none The month of the date of birth of the person with significant control
year string false none The year of the date of birth of the person with significant control

Document

{
  "back": {
    "data": "string",
    "name": "string"
  },
  "document_uuid": "string",
  "front": {
    "data": "string",
    "name": "string"
  },
  "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
  "type": "passport, driving_licence, residence_permit, visa, id_card"
}

Document

Properties

Name Type Required Restrictions Description
back Back false none none
document_uuid string false none uuid of the document attached to the check
front Front false none none
mime_type string false none The mime_type of the uploaded document. Accepted values are: image/jpeg, image/bmp, image/png, application/pdf, image/tiff
type string false none The type of the uploaded document. Accepted values are: passport, driving_licence, residence_permit, visa, id_card

DocumentData

{
  "check_uuid": "string",
  "country_code": "string",
  "date_of_birth": "string",
  "document_description": "string",
  "document_number": "string",
  "document_uuid": "string",
  "error_msg": "string",
  "expiry_date": "string",
  "first_name": "string",
  "gender": "string",
  "has_document_report": true,
  "id_type": "string",
  "is_expired": true,
  "is_mrz_validated": true,
  "last_name": "string",
  "mrz_line_1": "string",
  "mrz_line_2": "string",
  "mrz_line_3": "string",
  "nationality": "string",
  "notes": [
    "string"
  ],
  "personal_number": "string",
  "provider": "string",
  "providers_used": [
    "string"
  ],
  "status": "CHECKED_PASSED",
  "supplier_guid": "string"
}

DocumentData

Properties

Name Type Required Restrictions Description
check_uuid string false none Unique reference for the check uuid
country_code string false none Issuing country code for the document
date_of_birth string false none Date of birth in the document
document_description string false none Text description of the type of document. For example: Passport, Visa, Identity Card, Residence Permit
document_number string false none Document number of the document
document_uuid string false none Unique reference for the document uuid
error_msg string false none Error message in the event of any failures
expiry_date string false none Date of expiry of the document
first_name string false none First name in the document
gender string false none Gender in the document
has_document_report boolean false none none
id_type string false none Type of the identity document. Possible values are: P, I, D, U
is_expired boolean false none Confirmation whether document is expired
is_mrz_validated boolean false none Confirmation of whether MRZ has been validated
last_name string false none Last name in the document
mrz_line_1 string false none Line one of the Machine readable zone
mrz_line_2 string false none Line two of the Machine readable zone
mrz_line_3 string false none Line three of the Machine readable zone
nationality string false none Nationality in the document
notes [string] false none none
personal_number string false none Personal number of the document
provider string false none none
providers_used [string] false none none
status string false none Overall status of the document verification. Possible values are: CHECKED_PASSED, CHECKED_FAILED, CHECKED_UNREADABLE, COULD_NOT_CHECK
supplier_guid string false none Unique reference for the supplier uuid

Enumerated Values

Property Value
status CHECKED_PASSED
status CHECKED_FAILED
status CHECKED_UNREADABLE
status COULD_NOT_CHECK

DocumentSummary

{
  "document_uuid": "string",
  "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
  "name_back": "string",
  "name_front": "string",
  "type": "passport, driving_licence, residence_permit, visa, id_card, other",
  "uploaded_date": "yyyy-MM-dd HH:mm:ss"
}

DocumentSummary

Properties

Name Type Required Restrictions Description
document_uuid string false none uuid of the document attached to the check
mime_type string false none The mime type of the uploaded document
name_back string false none The name of the back side of the uploaded document with the extension. (only included if data is present)
name_front string false none The name of the front side of the uploaded document with the extension
type string false none The type of the uploaded document
uploaded_date string false none Date when the document was attached to the check in yyyy-MM-dd HH:mm:ss format

Education

{
  "degree": "string",
  "name": "string",
  "year": 0
}

Education

Properties

Name Type Required Restrictions Description
degree string false none The degree or focus of study
name string false none The name of the school/university attended
year integer(int32) false none The year attended

Employment

{
  "current": true,
  "name": "string",
  "title": "string"
}

Employment

Properties

Name Type Required Restrictions Description
current boolean false none Indicator of whether or not this is the current place of employment
name string false none The name of the organization/place of employment
title string false none Job or position title

Front

{
  "data": "string",
  "name": "string"
}

Front

Properties

Name Type Required Restrictions Description
data string false none The image data of the front side of the uploaded document in Base64 format. The original file cannot exceed 4MB.
name string false none The name of the front side of the uploaded document with the extension

Header

{
  "profile_uuid": "string",
  "remoteverify_enabled": true,
  "transaction_reference": "string"
}

Header

Properties

Name Type Required Restrictions Description
profile_uuid string true none ProfileUuid of the profile that will be used to perform the check
remoteverify_enabled boolean false none This flag needs to be enabled for a remote verify check
transaction_reference string false none Transaction reference that the user can provide for the check

Identification

{
  "country_registered": "string",
  "legal_authority": "string",
  "legal_form": "string",
  "place_registered": "string",
  "registration_number": "string"
}

Identification

Properties

Name Type Required Restrictions Description
country_registered string false none The country or state the corporate entity with significant control is registered in
legal_authority string false none The legal authority supervising the corporate entity with significant control
legal_form string false none The legal form of the corporate entity with significant control as defined by its country of registration
place_registered string false none The place the corporate entity with significant control is registered
registration_number string false none The registration number of the corporate entity with significant control

IdentificationDetail

{
  "issuing_country": "string",
  "number": "string",
  "type": "passport, driving_licence, residence_permit, visa, id_card"
}

IdentificationDetail

Properties

Name Type Required Restrictions Description
issuing_country string false none The issuing country of the identification document. 2 letter ISO3166 country code in upper case. For example: GB
number string false none Serial number of the identification document
type string false none The type of the identification document

InsolvencyData

{
  "address": [
    {
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "address_line4": "string",
      "address_line5": "string",
      "country": "string",
      "postcode": "string"
    }
  ],
  "aliases": [
    "string"
  ],
  "asset_total": 0,
  "case_description": "string",
  "case_number": "string",
  "case_type": "string",
  "court": "string",
  "debt_total": 0,
  "dob": "string",
  "name": "string",
  "occupation": "string",
  "presentation_date": "string",
  "service_office": "string",
  "start_date": "string",
  "status": "string",
  "trading_name": "string",
  "type": "string"
}

InsolvencyData

Properties

Name Type Required Restrictions Description
address [Address_in_the_insolvency_data] false none Top level data field for address at which the insolvency was registered
aliases [string] false none Other known aliases for the person subject to insolvency
asset_total number(double) false none Total assets the person had at the time of the sequestration
case_description string false none A description of the case
case_number string false none Court case number of the insolvency
case_type string false none Definition of the type of case
court string false none Name of the court at which the insolvency was registered
debt_total number(double) false none The amount of debt the sequestration relates to
dob string false none Date of birth of the person subject to insolvency
name string false none Name of the person who is subject to insolvency
occupation string false none The occupation of the person at the time of the insolvency
presentation_date string false none Date of presentation of a petition
service_office string false none Insolvency service office name and address
start_date string false none Date the insolvency started
status string false none Current status of the case
trading_name string false none Details of trading names that relate to the person
type string false none Insolvency type

LeiData

{
  "lei_number": "string"
}

LeiData

Properties

Name Type Required Restrictions Description
lei_number string false none Legal entity identifier number for the company

LinkedBusiness

{
  "business_name": "string",
  "position": "string"
}

LinkedBusiness

Properties

Name Type Required Restrictions Description
business_name string false none Name of linked business
position string false none Position of matched profile in business

LinkedPerson

{
  "association": "string",
  "name": "string"
}

LinkedPerson

Properties

Name Type Required Restrictions Description
association string false none Describes association between matched person and linked person
name string false none Name of linked person

Location

{
  "city": "string",
  "country": "string",
  "region": "string"
}

Location

Properties

Name Type Required Restrictions Description
city string false none City of the person
country string false none Country of the person
region string false none Region of the person

MainAddress

{
  "address_data": "string",
  "telephone": "string"
}

MainAddress

Properties

Name Type Required Restrictions Description
address_data string false none Registered address of the company as a String
telephone string false none Telephone number of the main addres

MatchSource

{
  "source": "string",
  "year": "string"
}

MatchSource

Properties

Name Type Required Restrictions Description
source string false none Source that is matched
year string false none Year the source has matched to

Note

{
  "data_source": "string",
  "snippet": [
    {
      "keywords_matched": [
        "string"
      ],
      "summary": "string",
      "title": "string"
    }
  ],
  "text": "string"
}

Note

Properties

Name Type Required Restrictions Description
data_source string false none Source of the note
snippet [Snippet] false none none
text string false none Note

Occupant

{
  "dob": "yyyy-mm-dd",
  "match_sources": [
    {
      "source": "string",
      "year": "string"
    }
  ],
  "name": "string",
  "phone_number": "string",
  "recency": "yyyy-mm-dd",
  "residency": "string"
}

Occupant

Properties

Name Type Required Restrictions Description
dob string false none The dateofbirth of other occupants listed at this address
match_sources [MatchSource] false none Top level data field for occupants match sources
name string false none Full names of other occupants listed at this address
phone_number string false none Telephone number as shown in the telephone directory
recency string false none Date of the last update which highlighted a specific additional occupant as listed at this address
residency string false none Year that a record was first received which highlighted a specific additional occupant was listed at this address

OfficerData

{
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "address_line6": "string",
    "country": "string",
    "postcode": "string"
  },
  "directorships": [
    {
      "appointed_date": "string",
      "company_name": "string",
      "company_number": "string",
      "company_status": "string",
      "position": "string",
      "resignation_date": "string",
      "type": "string"
    }
  ],
  "dob": "string",
  "name": "string",
  "nationality": "string"
}

OfficerData

Properties

Name Type Required Restrictions Description
address Address_in_the_officer_data false none none
directorships [Directorship] false none Top level data field directorship positions held by the director
dob string false none The date of birth of the director
name string false none The full name of the director
nationality string false none The directors nationality

OtherAddress

{
  "address_data": "string",
  "telephone": "string"
}

OtherAddress

Properties

Name Type Required Restrictions Description
address_data string false none Other address of the company as a String
telephone string false none Telephone number of the other address

OtherFinancials

{
  "contingent_liabilities": "string",
  "net_worth": "string",
  "working_capital": "string"
}

OtherFinancials

Properties

Name Type Required Restrictions Description
contingent_liabilities string false none Potential liabilities that are not recognised in the balance sheet
net_worth string false none Often referred to as the 'book value' of the business this equals Shareholders Funds less Intangible Assets
working_capital string false none Total Current Assets less Total Current Liabilities. This represents the surplus/deficit of funds from normal trading activities

PepAndSanctionDetails

{
  "address": [
    {
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "address_line4": "string",
      "address_line5": "string",
      "country": "string",
      "postcode": "string"
    }
  ],
  "aliases": [
    {
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    }
  ],
  "articles": [
    {
      "categories": [
        "string"
      ],
      "date_collected": "string",
      "original_url": "string",
      "provider_url": "string",
      "snippet": {
        "keywords_matched": [
          "string"
        ],
        "summary": "string",
        "title": "string"
      }
    }
  ],
  "dob": "string",
  "dod": "string",
  "email": "string",
  "first_name": "string",
  "gender": "string",
  "image_url": "string",
  "is_adverse_media": true,
  "is_deceased": true,
  "is_disqualified_director": true,
  "is_financial_regulator": true,
  "is_insolvent": true,
  "is_law_enforcement": true,
  "is_pep": true,
  "is_sanctions_current": true,
  "is_sanctions_previous": true,
  "last_name": "string",
  "linked_businesses": [
    {
      "business_name": "string",
      "position": "string"
    }
  ],
  "linked_persons": [
    {
      "association": "string",
      "name": "string"
    }
  ],
  "middle_name": "string",
  "mobile_number": "string",
  "nationality": "string",
  "notes": [
    {
      "data_source": "string",
      "snippet": [
        {
          "keywords_matched": [
            "string"
          ],
          "summary": "string",
          "title": "string"
        }
      ],
      "text": "string"
    }
  ],
  "pep_level": "string",
  "political_positions": [
    {
      "country": "string",
      "description": "string",
      "end_date": "string",
      "start_date": "string"
    }
  ],
  "sanctions": [
    {
      "is_current": true,
      "sanction_type": "string"
    }
  ],
  "score": "string",
  "telephone_number": "string",
  "year_of_birth": "string",
  "year_of_death": "string"
}

PepAndSanctionDetails

Properties

Name Type Required Restrictions Description
address [Address_in_the_sanctions_data] false none Top level data field for addresses linked with the matched person
aliases [Alias] false none Top level data field for aliases of the matched person
articles [Article] false none Top level data field for articles linked with the matched person
dob string false none Matched person’s date of birth
dod string false none Matched person’s date of death
email string false none Matched person’s email
first_name string false none Matched person’s forename
gender string false none Matched person’s gender
image_url string false none Link to matched person’s photo
is_adverse_media boolean false none Matched person belongs in adverse media dataset
is_deceased boolean false none Confirmation if the matched person is dead
is_disqualified_director boolean false none Matched person belongs in disqualified director dataset
is_financial_regulator boolean false none Matched person belongs in financial regulator dataset
is_insolvent boolean false none Matched person belongs in insolvency dataset
is_law_enforcement boolean false none Matched person belongs in law enforcement dataset
is_pep boolean false none Matched person is a PEP
is_sanctions_current boolean false none Matched person is currently sanctioned
is_sanctions_previous boolean false none Matched person was sanctioned in the past
last_name string false none Matched person’s lastname
linked_businesses [LinkedBusiness] false none Top level data field for businesses linked with matched person
linked_persons [LinkedPerson] false none Top level data field for persons linked with matched person
middle_name string false none Matched person’s middlename
mobile_number string false none Matched person’s mobile phone number
nationality string false none Matched person’s nationality
notes [Note] false none Top level data field for notes added to the matched person
pep_level string false none Matched person’s PEP level. Possible values are: 1,2,3 or 4
political_positions [PoliticalPosition] false none Top level data field for political positions for matched person
sanctions [Sanction] false none Top level data field for sanctions of the matched person
score string false none Matching score for matched person
telephone_number string false none Matched person’s home phone number
year_of_birth string false none Matched person’s year of birth
year_of_death string false none Matched person’s year of death

Person

{
  "bank_account": {
    "account": {
      "account_address_match": true,
      "account_name_match": true,
      "account_number_match": true,
      "account_status": "no_match",
      "sortcode_match": true
    },
    "bank": {
      "account_valid": true,
      "bank_name": "string",
      "branch_name": "string"
    }
  },
  "current_address": {
    "country": "'GB' is the country code for United Kingdom",
    "county": "string",
    "line_five": "string",
    "line_four": "string",
    "line_six": "string",
    "line_three": "string",
    "name_number": "string",
    "postcode": "string",
    "state": "string",
    "street": "string",
    "town": "string"
  },
  "date_of_birth": "yyyy-mm-dd",
  "documents": [
    {
      "back": {
        "data": "string",
        "name": "string"
      },
      "document_uuid": "string",
      "front": {
        "data": "string",
        "name": "string"
      },
      "mime_type": "image/jpeg, image/bmp, image/png, application/pdf, image/tiff",
      "type": "passport, driving_licence, residence_permit, visa, id_card"
    }
  ],
  "email_address": [
    "string"
  ],
  "first_name": "string",
  "gender": "male, female",
  "identification_details": [
    {
      "issuing_country": "string",
      "number": "string",
      "type": "passport, driving_licence, residence_permit, visa, id_card"
    }
  ],
  "last_name": "string",
  "middle_name": "string",
  "mpan": "string",
  "phone": [
    {
      "number": "string",
      "type": "mobile,landline"
    }
  ],
  "previous_address": [
    {
      "country": "'GB' is the country code for United Kingdom",
      "county": "string",
      "line_five": "string",
      "line_four": "string",
      "line_six": "string",
      "line_three": "string",
      "name_number": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "town": "string"
    }
  ],
  "title": "mr,mrs"
}

Person

Properties

Name Type Required Restrictions Description
bank_account BankAccount false none none
current_address Address_format_in_the_request false none none
date_of_birth string false none Person's date of birth in yyyy-mm-dd format
documents [Document] false none Person's document(s)
email_address [string] false none Person's email address
first_name string false none Person's first name
gender string false none Gender. Accepted values are: male, female
identification_details [IdentificationDetail] false none List of identification details to be validated. Must not contain duplicate types
last_name string false none Person's last name
middle_name string false none Person's middle name
mpan string false none Person's mpan number. For example: xx-xxxx-xxxx-xxx
phone [Phone] false none Person's phone details
previous_address [Address_format_in_the_request] false none Person's previous address
title string false none Title. Accepted values are: mr,mrs

PersonWithSignificantControl

{
  "address": {
    "address_line1": "string",
    "address_line2": "string",
    "address_line3": "string",
    "address_line4": "string",
    "address_line5": "string",
    "country": "string",
    "postcode": "string"
  },
  "country_of_residence": "string",
  "dob": {
    "month": "string",
    "year": "string"
  },
  "identification": {
    "country_registered": "string",
    "legal_authority": "string",
    "legal_form": "string",
    "place_registered": "string",
    "registration_number": "string"
  },
  "name": "string",
  "nationality": "string",
  "natures_of_control": [
    "string"
  ],
  "notified_on": "string",
  "type": "INDIVIDUAL"
}

PersonWithSignificantControl

Properties

Name Type Required Restrictions Description
address Address_in_the_PSC_data false none none
country_of_residence string false none The country of residence of the person with significant control
dob Dob false none none
identification Identification false none none
name string false none The name of the person with significant control
nationality string false none The nationality of the person with significant control
natures_of_control [string] false none The nature of control the person with significant control holds
notified_on string false none The date that Companies House was notified about this person with significant control
type string false none Type of the person with significant control. Possible values are: individual, corporate

Enumerated Values

Property Value
type INDIVIDUAL
type CORPORATE

Phone

{
  "number": "string",
  "type": "mobile,landline"
}

Phone

Properties

Name Type Required Restrictions Description
number string false none Landline (or) mobile phone number including the country code
type string false none Phone line type, the allowed values are 'mobile' and 'landline'

Photo

{
  "label": "string",
  "url": "string"
}

Photo

Properties

Name Type Required Restrictions Description
label string false none Type of the photo
url string false none URL to the photo

PoliticalPosition

{
  "country": "string",
  "description": "string",
  "end_date": "string",
  "start_date": "string"
}

PoliticalPosition

Properties

Name Type Required Restrictions Description
country string false none Political role country
description string false none Description of political role
end_date string false none Political role end date
start_date string false none Political role start date

Position

{
  "appointed_date": "string",
  "role": "string"
}

Position

Properties

Name Type Required Restrictions Description
appointed_date string false none The date the director was appointed
role string false none The directors role/position in a company

PreviousAddress

{
  "address_data": "string"
}

PreviousAddress

Properties

Name Type Required Restrictions Description
address_data string false none Previous address of the company as a String

PreviousCompanyName

{
  "date_changed": "string",
  "name": "string"
}

PreviousCompanyName

Properties

Name Type Required Restrictions Description
date_changed string false none Date this name was officially changed
name string false none Any previous name under which the company was registered

PreviousCreditRating

{
  "credit_limit": "string",
  "description": "string",
  "rating": "string"
}

PreviousCreditRating

Properties

Name Type Required Restrictions Description
credit_limit string false none Previous limit before it was last changed
description string false none A text description of the previous common credit rating
rating string false none The previous standardised credit rating

PreviousDirector

{
  "address_data": "string",
  "dob": "string",
  "gender": "Male",
  "name": "string",
  "position": [
    {
      "appointed_date": "string",
      "role": "string"
    }
  ]
}

PreviousDirector

Properties

Name Type Required Restrictions Description
address_data string false none The address of the previous director as a String
dob string false none The director's date of birth
gender string false none Gender. Possible values are: Male, Female
name string false none Full name of director
position [Position] false none Top level data field for director's position in the company

Enumerated Values

Property Value
gender Male
gender Female
gender Unknown

Profile

{
  "bio": "string",
  "name": "string",
  "url": "string"
}

Profile

Properties

Name Type Required Restrictions Description
bio string false none Bio of the profile on social platform
name string false none Source name of the profile
url string false none URL to the profile on social platform

ProfileSummary

{
  "name": "string",
  "uuid": "string"
}

ProfileSummary

Properties

Name Type Required Restrictions Description
name string false none Profile name of the profile used in the check
uuid string false none Profile UUID of the profile used in the check

ProfitAndLoss

{
  "amortisation": "string",
  "depreciation": "string",
  "dividends": "string",
  "extraordinary_costs": "string",
  "extraordinary_income": "string",
  "financial_expenses": "string",
  "financial_income": "string",
  "minority_interests": "string",
  "operating_costs": "string",
  "operating_profit": "string",
  "other_appropriations": "string",
  "pension_costs": "string",
  "profit_after_tax": "string",
  "profit_before_tax": "string",
  "retained_profit": "string",
  "revenue": "string",
  "tax": "string",
  "wages_and_salaries": "string"
}

ProfitAndLoss

Properties

Name Type Required Restrictions Description
amortisation string false none The amount written off Intangible Fixed Assets during the year
depreciation string false none The amount written off Tangible Fixed Assets during the year
dividends string false none The total amount of profits distributed to shareholders
extraordinary_costs string false none Costs incurred due to events of a non-recurring nature
extraordinary_income string false none Income arising due to events of a non-recurring nature
financial_expenses string false none Interest expenses incurred during the year
financial_income string false none Interest income earned during the year
minority_interests string false none Profits attributable to shareholders holding a minority interest in the company
operating_costs string false none Costs incurred in the general running of the business
operating_profit string false none The results of the company after deducting Operating Costs from its Revenue
other_appropriations string false none Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company
pension_costs string false none The cost of pension benefits for employees of the company
profit_after_tax string false none The results of the company after deducting any charge for taxation
profit_before_tax string false none The results of the company before deducting any charge for taxation
retained_profit string false none The results of the company after all income and expenses have been credited /debited.
revenue string false none Income earned from normal business activities, including the sale of goods and services
tax string false none Taxation payable on the profits of the company
wages_and_salaries string false none Wages and salaries paid to employees of the company

Property

{
  "matches": [
    {
      "match_type": "string",
      "ownership_type": "joint_ownership",
      "title_number": "string"
    }
  ],
  "sale_date": "string",
  "sale_price": "string",
  "tenure": "freehold",
  "type": "terrace"
}

Property

Properties

Name Type Required Restrictions Description
matches [PropertyMatch] false none Top level data field for property matches
sale_date string false none Date of the last sale of the property
sale_price string false none Price paid in GBP, the last time the property was sold
tenure string false none Tenure type of the property. Possible values are: freehold, leasehold, other
type string false none Type of the property. Possible values are: terrace, flat, detached, semi_detached, other

Enumerated Values

Property Value
tenure freehold
tenure leasehold
tenure other
type terrace
type flat
type detached
type semi_detached
type other

PropertyMatch

{
  "match_type": "string",
  "ownership_type": "joint_ownership",
  "title_number": "string"
}

PropertyMatch

Properties

Name Type Required Restrictions Description
match_type string false none Top level data field for property matches
ownership_type string false none Top level data field for property ownership type. Possible values are: joint_ownership, sole_ownership
title_number string false none none

Enumerated Values

Property Value
ownership_type joint_ownership
ownership_type sole_ownership

Ratios

{
  "creditor_days": "string",
  "current_debt_ratio": "string",
  "current_ratio": "string",
  "debtor_days": "string",
  "equity_in_percentage": "string",
  "gearing": "string",
  "liquidity_ratio_or_acid_test": "string",
  "pre_tax_profit_margin": "string",
  "return_on_captial_employed": "string",
  "return_on_net_assets_employed": "string",
  "return_on_total_assets_employed": "string",
  "sales_or_net_working_capital": "string",
  "stock_turnover_ratio": "string",
  "total_debt_ratio": "string"
}

Ratios

Properties

Name Type Required Restrictions Description
creditor_days string false none Trade Creditors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to settle its invoices for goods and services provided by it suppliers
current_debt_ratio string false none Total Current Liabilities / Shareholders Funds. This measures the amount of short term debt in relation to the value of shareholders funds
current_ratio string false none Total Current Assets / Total Current Liabilities. This is an indication of a company's ability to meet short-term debt obligations; the higher the ratio, the more liquid the company is
debtor_days string false none Trade Debtors / Turnover x 365 days. This is a calculation that predicts the average time taken for the company to collect its invoices for goods and services provided to its customers
equity_in_percentage string false none Shareholder Funds / (Total Current Assets + Tangible Fixed Assets) x 100. This ratio shows the worth of the company (shareholders funds) as a percentage of total current and tangible assets
gearing string false none Bank Overdraft & Loans + Total Long Term Liabilities/Shareholders funds x 100. This is the relationship between the size of the companies debt in proportion to Equity (Shareholders Funds)
liquidity_ratio_or_acid_test string false none Current assets - Stocks/Current Liabilities. This, like the current ratio, measures how quickly in the short term a company can meet its debts. However, this ratio excludes stock as there is no guarantee the value of Stocks can be realised quickly
pre_tax_profit_margin string false none Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the equivalent of retailers mark-up
return_on_captial_employed string false none Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return for the money (Capital) invested
return_on_net_assets_employed string false none Pre-Tax Profits / Net Assets x 100. This shows the return in percent on the net assets of the company. The higher the percentage the more profitable the company
return_on_total_assets_employed string false none Pre-Tax Profits / Total Assets x 100. This shows the return or profit on each pound of Assets used as a percentage
sales_or_net_working_capital string false none Turnover / (Total Current Assets - Total Current Liabilities). The higher the ratio the higher the volume of Sales made per the companies working capital
stock_turnover_ratio string false none Stocks / Turnover x 100. This shows the number of times the trading stock of a company is turned over in a trading period. If the ratio is low this indicates that relatively little money is tied up in Stocks
total_debt_ratio string false none Total Short Term & Long Term Debt / Shareholder Funds x 100. This shows the relative indebtedness of a company in relation to the worth of the company

Reason

{
  "act": "string",
  "article": "string",
  "description_identifier": "string",
  "section": "string"
}

Reason

Properties

Name Type Required Restrictions Description
act string false none none
article string false none none
description_identifier string false none none
section string false none none

ReportResponse

{
  "contact_index": 0,
  "contact_name": "string",
  "document_uuid": "string",
  "mime_type": "string",
  "report_uuid": "string",
  "supplier_name": "string",
  "type": "string"
}

ReportResponse

Properties

Name Type Required Restrictions Description
contact_index integer(int32) false none Index position of the contact
contact_name string false none Name of the contact
document_uuid string false none Unique documnetUuid of the document
mime_type string false none Tracks type of document
report_uuid string false none Unique reportUuid of the report
supplier_name string false none Name of supplier
type string false none Unique CheckUuid of the check

Resolution

{
  "code": "string",
  "description": "string"
}

Resolution

Properties

Name Type Required Restrictions Description
code string false none A code that specifies the outcome of UBO identification for a company
description string false none A description that specifies the outcome of UBO identification for a company

Sanction

{
  "is_current": true,
  "sanction_type": "string"
}

Sanction

Properties

Name Type Required Restrictions Description
is_current boolean false none Current (true) or previous (false) sanction
sanction_type string false none Type of sanctions. Possible values are: HMT, OFAC, EU, UN, Austrac

SearchLevelDetail

{
  "beneficial_owners": [
    {
      "name": "string",
      "owner_type": "string",
      "reason": "string"
    }
  ],
  "company_name": "string",
  "company_registration_number": "string",
  "country": "string",
  "search_level": 0
}

SearchLevelDetail

Properties

Name Type Required Restrictions Description
beneficial_owners [BeneficialOwner] false none Top level data field that identifies the beneficial owners for the company
company_name string false none Name of the company
company_registration_number string false none Registration number of the company
country string false none Country where the company is registered
search_level integer(int32) false none Indicates the level of the search

Shareholder

{
  "address_data": "string",
  "name": "string",
  "share_percent": "string"
}

Shareholder

Properties

Name Type Required Restrictions Description
address_data string false none Full address of the shareholder as a String
name string false none Name of shareholder
share_percent string false none Share percent

Snippet

{
  "keywords_matched": [
    "string"
  ],
  "summary": "string",
  "title": "string"
}

Snippet

Properties

Name Type Required Restrictions Description
keywords_matched [string] false none none
summary string false none none
title string false none none

SocialData

{
  "age": "string",
  "education": [
    {
      "degree": "string",
      "name": "string",
      "year": 0
    }
  ],
  "email": "string",
  "employment": [
    {
      "current": true,
      "name": "string",
      "title": "string"
    }
  ],
  "first_name": "string",
  "gender": "string",
  "last_name": "string",
  "locations": [
    {
      "city": "string",
      "country": "string",
      "region": "string"
    }
  ],
  "photos": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "profiles": [
    {
      "bio": "string",
      "name": "string",
      "url": "string"
    }
  ]
}

SocialData

Properties

Name Type Required Restrictions Description
age string false none Age of the person
education [Education] false none Top level data field for education of the person
email string false none Email address in the person request
employment [Employment] false none Top level data field for employment of the person
first_name string false none First name of the person
gender string false none Gender of the person
last_name string false none Last name of the person
locations [Location] false none Top level data field for location of the person
photos [Photo] false none Top level data field for photos of the person
profiles [Profile] false none Top level data field for social profiles of the person

UBOData

{
  "resolution": {
    "code": "string",
    "description": "string"
  },
  "search_level_details": [
    {
      "beneficial_owners": [
        {
          "name": "string",
          "owner_type": "string",
          "reason": "string"
        }
      ],
      "company_name": "string",
      "company_registration_number": "string",
      "country": "string",
      "search_level": 0
    }
  ]
}

UBOData

Properties

Name Type Required Restrictions Description
resolution Resolution false none none
search_level_details [SearchLevelDetail] false none Top level data field that records the information of all the company searches done in order to identify the UBO for a company

VersionResponse

{
  "date": "string",
  "version": "string"
}

VersionResponse

Properties

Name Type Required Restrictions Description
date string false none none
version string false none none

Address_format_in_the_request

{
  "country": "'GB' is the country code for United Kingdom",
  "county": "string",
  "line_five": "string",
  "line_four": "string",
  "line_six": "string",
  "line_three": "string",
  "name_number": "string",
  "postcode": "string",
  "state": "string",
  "street": "string",
  "town": "string"
}

Address format in the request

Properties

Name Type Required Restrictions Description
country string false none 2-character ISO country code of this address. Required for some profiles. For example: GB is the country code for United Kingdom
county string false none Address county
line_five string false none Address line 5
line_four string false none Address line 4
line_six string false none Address line 6
line_three string false none Address line 3
name_number string false none Flat/building name (or) number
postcode string false none Address postcode (or) ZIP
state string false none Address state
street string false none Address street
town string false none Address town

Address_in_the_PSC_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the PSC data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address of the person with significant control
address_line2 string false none The second line of the address of the person with significant control
address_line3 string false none The third line of the address of the person with significant control
address_line4 string false none The fourth line of the address of the person with significant control
address_line5 string false none The fifth line of the address of the person with significant control
country string false none The country of the address of the person with significant control
postcode string false none The postcode of the address of the person with significant control

Address_in_the_company_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the company data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address of the matched company
address_line2 string false none The second line of the address of the matched company
address_line3 string false none The third line of the address of the matched company
address_line4 string false none The fourth line of the address of the matched company
address_line5 string false none The fifth line of the address of the matched company
country string false none The country of the address of the matched company
postcode string false none The postcode of the address of the matched company

Address_in_the_court_disqualified_officer_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the court disqualified officer data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address as provided by the disqualifying authority
address_line2 string false none The second line of the address as provided by the disqualifying authority
address_line3 string false none The third line of the address as provided by the disqualifying authority
address_line4 string false none The fourth line of the address as provided by the disqualifying authority
address_line5 string false none The fifth line of the address as provided by the disqualifying authority
country string false none The country of the address as provided by the disqualifying authority
postcode string false none The postcode of the address as provided by the disqualifying authority

Address_in_the_court_judgement_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the court judgement data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address at which the court judgement was registered
address_line2 string false none The second line of the address at which the court judgement was registered
address_line3 string false none The third line of the address at which the court judgement was registered
address_line4 string false none The fourth line of the address at which the court judgement was registered
address_line5 string false none The fifth line of the address at which the court judgement was registered
country string false none The country of the address at which the court judgement was registered
postcode string false none The postcode of the address at which the court judgement was registered

Address_in_the_insolvency_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the insolvency data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address at which the insolvency was registered
address_line2 string false none The second line of the address at which the insolvency was registered
address_line3 string false none The third line of the address at which the insolvency was registered
address_line4 string false none The fourth line of the address at which the insolvency was registered
address_line5 string false none The fifth line of the address at which the insolvency was registered
country string false none The country of the address at which the insolvency was registered
postcode string false none The postcode of the address at which the insolvency was registered

Address_in_the_officer_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "address_line6": "string",
  "country": "string",
  "postcode": "string"
}

Address in the officer data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address for the director
address_line2 string false none The second line of the address for the director
address_line3 string false none The third line of the address for the director
address_line4 string false none The fourth line of the address for the director
address_line5 string false none The fifth line of the address for the director
address_line6 string false none The sixth line of the address for the director
country string false none The country of the address for the director
postcode string false none The postcode of the address for the director

Address_in_the_sanctions_data

{
  "address_line1": "string",
  "address_line2": "string",
  "address_line3": "string",
  "address_line4": "string",
  "address_line5": "string",
  "country": "string",
  "postcode": "string"
}

Address in the sanctions data

Properties

Name Type Required Restrictions Description
address_line1 string false none The first line of the address of the matched person
address_line2 string false none The second line of the address of the matched person
address_line3 string false none The third line of the address of the matched person
address_line4 string false none The fourth line of the address of the matched person
address_line5 string false none The fifth line of the address of the matched person
country string false none The country of the address of the matched person
postcode string false none The postcode of the address of the matched person