Documentation

Get started with International KYB

Learn how to perform KYB checks with the FrankieOne API.

Suggest Edits

This tutorial will walk through how to perform a KYB check for a business located in Ireland.

This workflow has the following basic steps.

Prerequisites

You will need the following to connect to the FrankieOne API,

  • Customer ID
  • API key

If you do not have any yet get in touch with our sales team.

Step 1: Search for the business

You can search for businesses across registries in different countries. You need to know the country you wish to search within and the name of the business. The name does not need to be the full legal name of the business. You can also search for businesses by their registration number, which will be specific to each registry.

Perform a business search with a partial name using the /business/international/search endpoint.

  1. In the example below, replace YOUR_CUSTOMER_ID with your Customer ID and YOUR_API_Key with your API key provided by FrankieOne.
  2. Copy the resulting code into your command line, and run the command.
curl --request POST \
     --url https://api.kycaml.uat.frankiefinancial.io/compliance/v1.2/business/international/search \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'
     --header 'content-type: application/json' \
     --data '{
       "country": "IE",
       "organisation_name": "RESTAURANT CREPES LE PHARE LIMITED"
     }'

The response will contain a list of businesses that matched against the supplied name parameter, such as:

Sample response
{
    "Companies": {
        "CompanyDTO": [
            {
                "Addresses": {
                    "Addresses": [
                        {
                            "AddressInOneLine": "17 OLDCOURT PARK,BRAY CO WICKLOW BRAYWICKLOW 99203"
                        }
                    ]
                },
                "Code": "650214",
                "CompanyID": "650214",
                "Name": "RESTAURANT CREPES LE PHARE LIMITED"
            }
        ]
    },
    "ibResponseCode": 100,
    "requestId": "01FZSNV0P13P0SC0MDQZ7TKKTT"
}

Step 2: Extract the company code

Searching for a business may return multiple matches. Each match will have a unique company code. Identify the correct match and extract the company code. you will need it in the next step.

For example, extract the company code for the first matched result:

const companyCode = response['Companies']['CompanyDTO'][0]['Code']

Step 3: Retrieve a business profile

Use the company code obtained in the previous step to retreive the profile for the business. The profile contains details such as the business address, legal status, and lists of directors, shareholders and office holders.

  1. In the example below, replace YOUR_CUSTOMER_ID with your Customer ID and YOUR_API_Key with your API key provided by FrankieOne.
  2. Replace COMPANY_CODE_FROM_PREVIOUS_STEP with the company code.
  3. Copy the resulting code into your command line, and run the command.
curl --request POST \
     --url https://api.kycaml.uat.frankiefinancial.io/compliance/v1.2/business/international/profile \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'
     --header 'content-type: application/json' \
     --data '{
       "company_code": "COMPANY_CODE_FROM_PREVIOUS_STEP",
       "country": "IE"
     }'
Sample response
{
    "CompanyProfile": {
        "Addresses": {
            "Addresses": [
                {
                    "AddressInOneLine": "17 OLDCOURT PARK, BRAY CO WICKLOW, A98 RY65, BRAYWICKLOW, 99203",
                    "AddressLine1": "17 OLDCOURT PARK",
                    "AddressLine2": "BRAY CO WICKLOW",
                    "AddressLine3": "A98 RY65",
                    "AddressLine4": "BRAYWICKLOW",
                    "Postcode": "99203"
                }
            ]
        },
        "Code": "650214",
        "Date": "2022-04-04T06:59:08.2229476Z",
        "LegalForm": "LTD - PRIVATE COMPANY LIMITED BY SHARES",
        "Name": "RESTAURANT CREPES LE PHARE LIMITED",
        "directorAndShareDetails": {
            "directors": {
                "Director": [
                    {
                        "address1": "17 OLDCOURT PARK",
                        "address2": "BRAY CO. WICKLOW",
                        "address3": "A98 RY65",
                        "birthdate": "17/08/1980",
                        "directorships": {
                            "Directorship": [
                                {
                                    "appointedDate": "20/05/2019",
                                    "companyName": "RESTAURANT CREPES LE PHARE LIMITED",
                                    "companyNumber": "650214",
                                    "companyStatus": "Active - Accounts Filed",
                                    "function": "Director"
                                }
                            ]
                        },
                        "name": "BEN FLEAU"
                    },
                    {
                        "address1": "17 OLDCOURT PARK",
                        "address2": "BRAY CO. WICKLOW",
                        "address3": "A98 RY65",
                        "birthdate": "27/09/1975",
                        "directorships": {
                            "Directorship": [
                                {
                                    "appointedDate": "20/05/2019",
                                    "companyName": "RESTAURANT CREPES LE PHARE LIMITED",
                                    "companyNumber": "650214",
                                    "companyStatus": "Active - Accounts Filed",
                                    "function": "Director"
                                },
                                {
                                    "appointedDate": "20/05/2019",
                                    "companyName": "RESTAURANT CREPES LE PHARE LIMITED",
                                    "companyNumber": "650214",
                                    "companyStatus": "Active - Accounts Filed",
                                    "function": "Company Secretary"
                                }
                            ]
                        },
                        "name": "LOUIS BRANCOURT"
                    },
                    {
                        "address1": "17 OLDCOURT PARK",
                        "address2": "BRAY CO. WICKLOW",
                        "address3": "A98 RY65",
                        "birthdate": "27/09/1975",
                        "directorships": {
                            "Directorship": [
                                {
                                    "appointedDate": "20/05/2019",
                                    "companyName": "RESTAURANT CREPES LE PHARE LIMITED",
                                    "companyNumber": "650214",
                                    "companyStatus": "Active - Accounts Filed",
                                    "function": "Director"
                                },
                                {
                                    "appointedDate": "20/05/2019",
                                    "companyName": "RESTAURANT CREPES LE PHARE LIMITED",
                                    "companyNumber": "650214",
                                    "companyStatus": "Active - Accounts Filed",
                                    "function": "Company Secretary"
                                }
                            ]
                        },
                        "name": "LOUIS BRANCOURT"
                    }
                ]
            },
            "shareHolderSummary": {
                "shareCapital": "100"
            },
            "shareHolders": {
                "ShareholderDetails": [
                    {
                        "allInfo": "75.00 ORDINARY A  EUR 1.00",
                        "currency": "EUR",
                        "name": "LOUIS BRANCOURT",
                        "nominalValue": "1",
                        "percentage": "75",
                        "shareCount": 75,
                        "shareType": "ORDINARY A",
                        "shareholderType": "P",
                        "totalShareCount": 100,
                        "totalShareValue": 100,
                        "totalShares": 100
                    },
                    {
                        "allInfo": "25.00 ORDINARY A  EUR 1.00",
                        "currency": "EUR",
                        "name": "BEN FLEAU",
                        "nominalValue": "1",
                        "percentage": "25",
                        "shareCount": 25,
                        "shareType": "ORDINARY A",
                        "shareholderType": "P",
                        "totalShareCount": 100,
                        "totalShareValue": 100,
                        "totalShares": 100
                    }
                ]
            }
        }
    },
    "checkId": "7399d480-b6fa-30e5-f842-3879f0ec38ee",
    "entityId": "73abf624-bbba-ed24-3b4e-5b8a5ebb8bdc",
    "ibRetrievalLocation": "https://data.kyckr.com/integration/1340479351",
    "requestId": "01FZSNXFNPQK9306RRMVCWH9NM"
}

Next Steps

The above steps assist in searching and creating an entity for any International Business.

Please see - International KYB Flows and Sequence

Updated about 1 month ago