KYC verification of private companies (GBR)

Use this API call to perform KYC verification of private companies.

Parameters

Name	Type	Description
`country` (required)	string	3 letter country ISO
`name` (required)	string
`entityNumber` (required)	string
`registeredOffice`	string	address
`principalPlaceOfBusiness`	string	address
`companyExtract`	string	base64 Data URI (JPG/PNG/PDF)
`stakeholders`	array	shareholders / directors

Stakeholder types

Name	Type	Note
`shareholders`	individual
`directors`	individual

Note

Base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:

data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...

Runnable example


// api endpoint
const apiEndpoint = 'https://dev.bronid.com/verify';

// request body
const kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_userId": "yourUniqueUserId",
	
	"type": "privateCompany",
    "fields": {
        "country": "GBR",
        "name": "Priv Co Name",
        "entityNumber": "123456",
        "registeredOffice": "Registered office GBR",
        "principalPlaceOfBusiness": "Principal office GBR",
        "companyExtract": "data:application/pdf;base64,JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
    },
    "stakeholders": [
        {
            "type": "individual",
            "role": "shareholders",
            "fields": {
	            "country": "GBR",
	            "firstName": "Jane",
	            "middleName": "ok",
	            "lastName": "Citizen",
	            "gender": "female",
	            "dateOfBirth": "20/10/1980",
	            "address": "210 Pentonville Road",
	            "unitNumber": "",
	            "streetNumber": "210",
	            "streetName": "Pentonville",
	            "streetType": "Road",
	            "locality": "London",
	            "postcode": "N19AA",
	            "phone": "2074999000",
	            "email": "email@gmail.com"
            }
        },
        {
            "type": "individual",
            "role": "directors",
            "fields": {
                "firstName": "American",
                "middleName": "ok",
                "lastName": "Person",
                "gender": "female",
                "dateOfBirth": "30/10/1982",
                "email": "person@email.com",
                "country": "USA",
                "socialSecurityNumber": "12345",
                "address": "250 Point Lobos Ave, San Francisco CA",
                "unitNumber": "",
                "streetNumber": "250",
                "streetName": "Point Lobos",
                "streetType": "Ave",
                "suburb": "San Francisco",
                "postcode": "941211471",
                "state": "CA",
                "phone": "0432248425"
            }
        }
    ]
};

console.log('Running request...')

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.