KYC verification for private companies (GBR)

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

Parameters

NameTypeDescription
country (required)string3 letter country ISO
name (required)string
entityNumber (required)string
registeredOfficestringaddress
principalPlaceOfBusinessstringaddress
companyExtractstringbase64 document (JPG/PNG/PDF)
stakeholdersarrayshareholders / directors

Stakeholder types

NameTypeNote
shareholdersindividual
directorsindividual

Runnable example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/verify';

// request body
const kycData = {
	// authorization
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "dev_secret_key",
	"metadata_userId": "yourUniqueUserId",
	
	// entity details
	"type": "privateCompany",
    "fields": {
        "country": "GBR",
        "name": "Priv Co Name",
        "entityNumber": "123456",
        "registeredOffice": "Registered office GBR",
        "principalPlaceOfBusiness": "Principal office GBR",
        "companyExtract": "data:application/pdf;base64,JVBERi0xL.....DQo="
    },
    "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"
            }
        }
    ]
};

// submit the KYC data to the bronID API
axios
	.post(apiEndpoint, kycData)
	.then(res => {
		// print the verification results
		console.log("click the results to expand them");
		console.log(JSON.stringify(res.data, null, 2));
	})
	.catch(error => {
		console.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.