Entity lookup (PREVIEW)

Note

This endpoint is currently in preview and is subject to breaking changes. It is based on a different request format than the rest of the bronID API.

Authentication

Read the authentication guide at API Authentication (PREVIEW)

Request format

Method

GET

Parameters

Response

The response is a JSON object.

Names array

The names array contains the different names the entity is known by.

Entity numbers array

The entity numbers array contains the different entity numbers the entity is known by.

Address object

The address object contains the address of the entity.

Request examples

// api endpoint https://dev.bronid.com/v5/lookup
const apiCall = 'https://dev.bronid.com/v5/lookup?country=AUS&id=123123123';

// GET request with parameters
fetch(apiCall)
  .then(response => response.json())
  .then(data => {
    if (data.match) {
      console.log('Entity found:', data);
    } else {
      console.log('Entity not found', data);
    }
  });

Sample response (matched):

{
	"match": true,
	"country": "AUS",
	"name": "TELSTRA CORPORATION LIMITED",
	"names": [
		{
			"value": "TELSTRA INFRACO",
			"type": "businessName"
		},
		{
			"value": "TELECOM AUSTRALIA",
			"type": "businessName"
		},
		{
			"value": "TELSTRA",
			"type": "tradingName"
		},
		{
			"value": "TELSTRA CORPORATION LIMITED",
			"type": "tradingName"
		},
		// ...
	],
	"entityNumber": "33051775556",
	"entityNumbers": [
		{
			"value": "33051775556",
			"type": "ABN"
		},
		{
			"value": "051775556",
			"type": "ACN"
		}
	],
	"entityStatus": "Active",
	"entityType": "Australian Public Company",
	"entityTypeCode": "publicCompany",
	"address": {
		"text": "VIC 3000",
		"state": "VIC",
		"postcode": "3000"
	}
}

Sample response (not matched):

{
	"match": false,
    "message": "Could not find entity."
}

Runnable example

const apiEndpoint = 'https://dev.bronid.com/v5/lookup';
// lookup parameters
const queryParams = {
    country: 'AUS',
    id: '33051775556',
};

// Convert the query parameters to a query string
const queryString = new URLSearchParams(queryParams).toString();
// add the query string with a "?" prefix e.g. ?country=AUS&id=33051775556
const urlWithQuery = `${apiEndpoint}?${queryString}`;

// API authentication
const headers = {
  'Authorization': 'ApiKey XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314',
};

// Perform the fetch request
fetch(urlWithQuery, {
	method: 'GET',
	headers: headers,
})
	.then(response => {
		if (!response.ok) {
      throw new Error(`HTTP error! Status: ${response.status}`);
    }

		return response.json(); // Parse JSON response
	})
	.then(data => {
		console.log('Response data:', data);
	})
	.catch(error => {
		console.error('Fetch error:', error);
	});

    // Click “▶ run” to try this code live and run your first KYC.
    ```