Get started with KYB

Learn how to perform KYB checks with the FrankieOne API.

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

This workflow has four 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, as well as 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.demo.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"
     }'

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, A98 RY65, BRAY, WICKLOW, A98RY65, IRELAND, IRELAND",
                            "AddressLine1": "17 OLDCOURT PARK",
                            "AddressLine2": "BRAY CO. WICKLOW",
                            "AddressLine3": "A98 RY65",
                            "AddressLine4": "BRAY, WICKLOW, A98RY65, IRELAND",
                            "Country": "IRELAND"
                        }
                    ]
                },
                "Code": "650214",
                "CompanyID": "650214",
                "LegalForm": "LTD - Private Company Limited by Shares",
                "LegalStatus": "Normal ",
                "Name": "RESTAURANT CREPES LE PHARE LIMITED"
            }
        ]
    },
    "ibResponseCode": 100,
    "requestId": "01FS8E0DR4QZK6ZQ4KJ0GMTSBZ"
}

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.demo.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"
     }'

Step 4: Perform checks on the business

FrankieOne automatically creates an Entity object of type ORGANISATION when you retrieve a business profile. This entity's ID is available from the entityId field of the previous step's response object.

Perform a KYC check on the business.

  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 ENTITY_ID with the entity ID.
  3. Copy the resulting code into your command line, and run the command.
curl --request POST \
     --url https://api.demo.frankiefinancial.io/compliance/v1.2/entity/ENTITY_ID/verify/default/summary \
     --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \
     --header 'api_key: YOUR_API_KEY'
     --header 'content-type: application/json'

Next Steps

Implement workflows for specific countries

If you know the country a business is from upfront you can implement more specific workflows.


Did this page help you?