Skip to main content

​
Request

[GET]
{{baseUrl}}/api/v1/kyb/business/detail
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query parameter

ParameterTypeDescriptionRequired
international_number *stringInternational number of companyrequired
country_code *stringCountry Code of business countryrequired

​
Sample response

Response
{
    "entity": {
        "name": "JOHN DOE INC",
        "internationalNumber": "1769635",
        "localNumber": "C1769635",
        "dateCreated": "2022-01-24T00:00:00.000Z",
        "address": "500 S BUENA VISTA ST BURBANK CA 91521",
        "paidShareCapital": "10000000 NGN",
        "sharesValue": "0.01 NGN",
        "sharesIssued": "10000000",
        "activityDescription": "To be in the business of providing Demo services.",
        "oldInternationalNumber": "1769635",
        "country": {
            "name": "California",
            "code": "us-ca",
            "currency": "USD",
            "sources": [
                {
                    "url": "https://businesssearch.sos.ca.gov/",
                    "name": "California Secretary of State"
                }
            ]
        },
        "type": {
            "type": "Private company limited by shares",
            "isIndividual": false
        },
        "statuses": [
            {
                "providerId": "Active",
                "providerName": "Active"
            }
        ],
        "activities": [
            {
                "providerId": "143269",
                "providerName": "Other personal services activities",
                "createdAt": "2021-11-07T13:47:47.959002+00:00",
                "type": {
                    "id": 1,
                    "name": "Primary"
                }
            }
        ],
        "parentCountry": null,
        "addresses": [
            {
                "address": "500 S BUENA VISTA ST BURBANK CA 91521",
                "companies": []
            }
        ],
        "persons": [
            {
                "sourceNum": 1,
                "person": {
                    "id": null,
                    "name": null,
                    "countryId": 24,
                    "occupation": null,
                    "nationality": null,
                    "address": null,
                    "countryOfResidence": null,
                    "honorific": null,
                    "number": "1811271",
                    "isForeign": null,
                    "hideAddress": null,
                    "email": null,
                    "phone": null,
                    "countryCode": "us-ca"
                },
                "role": {
                    "id": 60318,
                    "name": "Agent",
                    "providerId": null,
                    "isInactive": null
                },
                "naturesOfControl": [],
                "personShares": []
            }
        ],
        "companyContacts": {
            "email": [
                "adm***********"
            ]
        },
        "personsCount": "1",
        "companyContactsCount": "1"
    }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the business details
entity.namestringRegistered name of the business
entity.internationalNumberstringInternational registration number
entity.localNumberstringLocal registration number
entity.dateCreatedstringDate the business was created (ISO 8601 format)
entity.addressstringPrimary registered address
entity.paidShareCapitalstringTotal paid-up share capital with currency
entity.sharesValuestringValue per share with currency
entity.sharesIssuedstringTotal number of shares issued
entity.activityDescriptionstringDescription of business activities
entity.oldInternationalNumberstringPrevious international registration number
entity.countryobjectCountry details for the business registration
entity.country.namestringName of the country or region
entity.country.codestringCountry or region code
entity.country.currencystringCurrency code (e.g., “USD”)
entity.country.sourcesarrayList of registry data sources
entity.country.sources[].urlstringURL of the data source
entity.country.sources[].namestringName of the data source
entity.typeobjectBusiness entity type details
entity.type.typestringType of business entity (e.g., “Private company limited by shares”)
entity.type.isIndividualbooleanWhether the entity is registered as an individual
entity.statusesarrayList of business statuses
entity.statuses[].providerIdstringStatus identifier from the provider
entity.statuses[].providerNamestringStatus display name from the provider
entity.activitiesarrayList of business activities
entity.activities[].providerIdstringActivity identifier from the provider
entity.activities[].providerNamestringActivity description from the provider
entity.activities[].createdAtstringDate the activity record was created (ISO 8601 format)
entity.activities[].typeobjectActivity type classification
entity.activities[].type.idnumberActivity type ID
entity.activities[].type.namestringActivity type name (e.g., “Primary”)
entity.parentCountrystring | nullParent country if applicable
entity.addressesarrayList of registered addresses
entity.addresses[].addressstringFull address string
entity.addresses[].companiesarrayAssociated companies at this address
entity.personsarrayList of persons associated with the business
entity.persons[].sourceNumnumberSource number reference
entity.persons[].personobjectPerson details
entity.persons[].person.idstring | nullPerson identifier
entity.persons[].person.namestring | nullPerson’s full name
entity.persons[].person.countryIdnumberCountry ID reference
entity.persons[].person.occupationstring | nullPerson’s occupation
entity.persons[].person.nationalitystring | nullPerson’s nationality
entity.persons[].person.addressstring | nullPerson’s address
entity.persons[].person.countryOfResidencestring | nullPerson’s country of residence
entity.persons[].person.honorificstring | nullPerson’s honorific or title
entity.persons[].person.numberstringPerson’s registration number
entity.persons[].person.isForeignboolean | nullWhether the person is a foreign national
entity.persons[].person.hideAddressboolean | nullWhether the person’s address is hidden
entity.persons[].person.emailstring | nullPerson’s email address
entity.persons[].person.phonestring | nullPerson’s phone number
entity.persons[].person.countryCodestringPerson’s country code
entity.persons[].roleobjectPerson’s role in the company
entity.persons[].role.idnumberRole identifier
entity.persons[].role.namestringRole name (e.g., “Agent”, “Director”)
entity.persons[].role.providerIdstring | nullRole provider identifier
entity.persons[].role.isInactiveboolean | nullWhether the role is currently inactive
entity.persons[].naturesOfControlarrayNature of control entries for this person
entity.persons[].personSharesarrayShare ownership details for this person
entity.companyContactsobjectCompany contact information
entity.companyContacts.emailarrayList of email addresses (partially masked)
entity.personsCountstringTotal number of associated persons
entity.companyContactsCountstringTotal number of contact entries