Skip to main content

Signicat Data Verification API (1.0.0)

Download OpenAPI specification:Download

Introduction

The Data Verification API returns normalised data from carefully-selected data sources through a single point of integration, making it easy for you to interpret and use the responses regardless of the source.

The Data Verification API is a RESTful API that uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

This API reference provides information on available endpoints and how to interact with them. To learn more about the features of this product, visit the Data Verification documentation.

Get started

Initial preparations

Before you can use the API, you must have completed the following initial preparations:

  1. Sign up to the Signicat Dashboard.
  2. In the Signicat Dashboard, set up an organisation and an account. It is also possible to add a domain, but this is not necessary for this API.
    You can find out how to configure these in our Initial setup instructions.

If you require support, you can contact us at support@signicat.com.

Get API client credentials

To access the Data Verification API, you need to create an API client and a client secret with the correct permissions. To connect and authenticate to the API, you need to complete the following steps:

  1. You need to set up an API client as described in the set up an API client guide. From this step, you will obtain a Client ID and a Client Secret.
  2. To connect to the Data Verification API you need to configure the required permissions for you API client. Ensure that you select both the Data Verification for natural persons and the Data Verification for organisations permissions.

We recommend that you create one API client per API product, but this can depend on your use case or configuration.

You are now all set to use the Data Verification API!

Learn more about how to authenticate and send your first request to the API in the Obtaining an access token documentation.

Organizations

This API returns information about an organization.

Learn more about the different data sources in the developer documentation. Also, refer to Sources section (below) to learn how to configure the data sources which you would like to use.

Basic

Retrieve basic info about an organization

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "name": "SIGNICAT AS",
  • "names": [
    ],
  • "organizationNumber": "989584022",
  • "vatNumber": "989584022",
  • "registrationDate": null,
  • "country": {
    },
  • "businessAddress": {
    },
  • "addresses": [
    ],
  • "organizationType": {},
  • "legalStatus": "active",
  • "employees": 132,
  • "industries": [
    ],
  • "contact": null,
  • "metadata": {}
}

Authorization

This endpoint returns which people are allowed to sign and act on behalf of an organization.
If multiple people have to sign together, those people will be mentioned together in a so-called “combination”. If multiple combinations exist, they will all be calculated by the API and returned. The API will report if it was able to calculate all combinations, only a part of the possible combinations, or no combinations. The API will also return a list of the individual people with signing rights and their respective roles.

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "signature": {
    },
  • "powerOfProcuration": {
    },
  • "metadata": {}
}

Ownership

Retrieve ownership info for an organization

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ],
  • "otherShareholders": null,
  • "metadata": {
    }
}

Roles

Retrieve information about roles in an organization

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
expand
Array of strings

Optionally request one or more attributes, by default all available attributes are included.

idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "persons": [
    ],
  • "companies": [
    ],
  • "others": null,
  • "metadata": {
    }
}

Ultimate beneficial owners

Retrieve information about ultimate beneficial owners for an organization

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "ultimateBeneficiaryOwners": [
    ],
  • "metadata": {
    }
}

Finance

Retrieve financial info for an organization

path Parameters
country
required
string

ISO 3166-1 country code

id
required
string

Id of the organization

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "creditRating": {},
  • "numberOfPaymentRemarks": 0,
  • "profitAndLoss": [
    ],
  • "netWorth": [ ],
  • "metadata": {
    }
}

Account Holder Verification

Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.

path Parameters
country
required
string

ISO 3166-1 country code

accountNumber
required
string

Account number of the organization

query Parameters
idList
Array of strings

Parameter used to specify a list of id checks. Allowed values are NL_KVK, NL_KVK_BRANCH, EU_VAT, FR_SIREN, FR_SIRET and UK_CRN. This parameter applies to a limited number of sources. For data sources in Italy, this is a required parameter and must be set to EU_VAT. Format to specify the attribute should be as follows NL_KVK, 01234565

idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax, external and IBAN, defaults to organization or IBAN based on endpoint and is only used by a limited number of sources.

name
string

Company Name

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

id
string

Id of the organization

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "string",
  • "isValidAccountNumber": true,
  • "validationDetails": [
    ],
  • "country": {
    },
  • "accountDetails": {
    },
  • "metadata": {
    }
}

Screening

AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax and external, defaults to organization and is only used by a limited number of sources.

countries
string <= 50 characters

Comma-separated list of countries to include in the search - ISO 3166-1 format

id
string <= 100 characters

Id of the entity to search for

name
string <= 100 characters

Name of the entity to search for

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

listType
string

Comma-separated string of list types to screen against, defaults to all lists. Allowed values are pep, sanction and adverseMedia.

offset
integer <int32>

Used for paging

limit
integer <int32>

Set how many results you want per page (max/default 100)

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 100,
  • "size": 1,
  • "data": [
    ],
  • "metadata": {
    }
}

Search - Beta

Search for an organization.

        Remarks when searching multiple sources:
        Functionality is subject to change without prior notice.
query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are organization, tax and external, defaults to organization and is only used by a limited number of sources.

countries
string <= 50 characters

Comma-separated list of countries to include in the search - ISO 3166-1 format

id
string <= 100 characters

Id of the entity to search for

name
string <= 100 characters

Name of the entity to search for

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

cursor
string

Cursor returned for paginating multiple sources, cannot be used together with offset and limit.

offset
integer <int32>

Used for paging

limit
integer <int32>

Set how many results you want per page (max/default 100)

Responses

Response samples

Content type
application/json
{}

Persons

This API returns information about a person.

Learn more about the different data sources in the developer documentation. Also, refer to Sources section (below) to learn how to configure the data sources which you would like to use.

Basic

Retrieve basic info about a person

path Parameters
country
required
string

ISO 3166-1 country code

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are PersonalId, Passport, IdentityCard, DriversLicense, TravelDocument, ResidentPermit, TaxNumber and VoterId, defaults to PersonalId and is only used by a limited number of sources.

identityNumber
string

The national identity number used to identify the person

givenName
string

The persons given name

surname
string

The persons surname

dateOfBirth
string or null <yyyy-MM-dd>

The persons date of birth

caseRef
string

Case reference if required by the source

street
string

The persons street address

streetNumber
string

The persons street address number

postalCode
string

The persons postal code

city
string

The persons city place

gender
string

The person's gender. Optional parameter. Allowed values are Male, Female, Other, Unknown. Defaults to Unknown and only applies to a limited number of data sources.

phoneNumber
string

PhoneNumber for the Identity verification

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "names": [
    ],
  • "birth": {
    },
  • "death": {
    },
  • "nationalities": [
    ],
  • "citizenships": null,
  • "permanentAddresses": [
    ],
  • "postalAddresses": [
    ],
  • "foreignAddresses": [ ],
  • "metadata": {
    }
}

Address Deprecated

Retrieve address info for a person. This endpoint is deprecated, use Basic instead.

path Parameters
country
required
string

ISO 3166-1 country code

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are PersonalId, Passport, IdentityCard, DriversLicense, TravelDocument, ResidentPermit, TaxNumber and VoterId, defaults to PersonalId and is only used by a limited number of sources.

identityNumber
string

The national identity number used to identify the person

givenName
string

The persons given name

surname
string

The persons surname

dateOfBirth
string or null <yyyy-MM-dd>

The persons date of birth

caseRef
string

Case reference if required by the source

street
string

The persons street address

streetNumber
string

The persons street address number

postalCode
string

The persons postal code

city
string

The persons city place

gender
string

The person's gender. Optional parameter. Allowed values are Male, Female, Other, Unknown. Defaults to Unknown and only applies to a limited number of data sources.

phoneNumber
string

PhoneNumber for the Identity verification

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "permanent": {
    },
  • "postal": {
    },
  • "foreign": null,
  • "metadata": {
    }
}

Finance

Retrieve finance info for a person

path Parameters
country
required
string

ISO 3166-1 country code

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are PersonalId, Passport, IdentityCard, DriversLicense, TravelDocument, ResidentPermit, TaxNumber and VoterId, defaults to PersonalId and is only used by a limited number of sources.

identityNumber
string

The national identity number used to identify the person

givenName
string

The persons given name

surname
string

The persons surname

dateOfBirth
string or null <yyyy-MM-dd>

The persons date of birth

caseRef
string

Case reference if required by the source

street
string

The persons street address

streetNumber
string

The persons street address number

postalCode
string

The persons postal code

city
string

The persons city place

gender
string

The person's gender. Optional parameter. Allowed values are Male, Female, Other, Unknown. Defaults to Unknown and only applies to a limited number of data sources.

phoneNumber
string

PhoneNumber for the Identity verification

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "creditScore": {
    },
  • "numberOfPaymentRemarks": 1,
  • "incomeAndWealth": [
    ],
  • "metadata": {
    }
}

Identity Verification

Verification of a person identity

path Parameters
country
required
string

ISO 3166-1 country code

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are PersonalId, Passport, IdentityCard, DriversLicense, TravelDocument, ResidentPermit, TaxNumber and VoterId, defaults to PersonalId and is only used by a limited number of sources.

identityNumber
string

The national identity number used to identify the person

givenName
string

The persons given name

surname
string

The persons surname

dateOfBirth
string or null <yyyy-MM-dd>

The persons date of birth

caseRef
string

Case reference if required by the source

street
string

The persons street address

streetNumber
string

The persons street address number

postalCode
string

The persons postal code

city
string

The persons city place

gender
string

The person's gender. Optional parameter. Allowed values are Male, Female, Other, Unknown. Defaults to Unknown and only applies to a limited number of data sources.

phoneNumber
string

PhoneNumber for the Identity verification

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "status": "notIdentified",
  • "description": "string",
  • "metadata": {
    }
}

Account Holder Verification

Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.

path Parameters
country
required
string

ISO 3166-1 country code

accountNumber
required
string

Account number of the person

query Parameters
idType
string

Optional hint to what kind of id being used. Allowed values are PersonalId, Passport, IdentityCard, DriversLicense, TravelDocument, ResidentPermit, TaxNumber and VoterId, defaults to PersonalId and is only used by a limited number of sources.

identityNumber
string

The national identity number used to identify the person

givenName
string

The persons given name

surname
string

The persons surname

dateOfBirth
string or null <yyyy-MM-dd>

The persons date of birth

caseRef
string

Case reference if required by the source

street
string

The persons street address

streetNumber
string

The persons street address number

postalCode
string

The persons postal code

city
string

The persons city place

gender
string

The person's gender. Optional parameter. Allowed values are Male, Female, Other, Unknown. Defaults to Unknown and only applies to a limited number of data sources.

phoneNumber
string

PhoneNumber for the Identity verification

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "string",
  • "isValidAccountNumber": true,
  • "validationDetails": [
    ],
  • "country": {
    },
  • "accountDetails": {
    },
  • "metadata": {
    }
}

Search - Beta

Search for an person. Functionality is subject to change without prior notice.

query Parameters
dateOfBirth
string <= 10 characters

Date of birth of the entity to search for, accepted formats: yyyy-MM-dd, yyyy-MM or yyyy

postalCode
string

Search person through postal code

countries
string <= 50 characters

Comma-separated list of countries to include in the search - ISO 3166-1 format

id
string <= 100 characters

Id of the entity to search for

name
string <= 100 characters

Name of the entity to search for

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

offset
integer <int32>

Used for paging

limit
integer <int32>

Set how many results you want per page (max/default 100)

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 100,
  • "size": 1,
  • "links": {
    },
  • "data": [
    ],
  • "metadata": {
    }
}

Screening

AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.

query Parameters
dateOfBirth
string <= 10 characters

Date of birth of the entity to search for, accepted formats: yyyy-MM-dd, yyyy-MM or yyyy

postalCode
string

Search person through postal code

countries
string <= 50 characters

Comma-separated list of countries to include in the search - ISO 3166-1 format

id
string <= 100 characters

Id of the entity to search for

name
string <= 100 characters

Name of the entity to search for

source
string <= 50 characters

Optional name of the source to use

rawJson
boolean

Optionally include the raw data received from the upstream if supported by the source

listType
string

Comma-separated string of list types to screen against, defaults to all lists. Allowed values are pep, sanction and adverseMedia.

offset
integer <int32>

Used for paging

limit
integer <int32>

Set how many results you want per page (max/default 100)

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 100,
  • "size": 1,
  • "data": [
    ],
  • "metadata": {
    }
}

Sources

Contains information about the different sources used by the API.

It is possible to instruct the API to use a preferred source across profiles by including a JWT of the following model in the request headers. { "ver": 1, "rules": [ { "scope": [ "basic", ], "sources": [ "nameOfSource" ] } ], "strict": true }

If the source is specified by query parameter for a request, this will be used instead of any header.

Organization

Returns the data sources available for organizations.

Responses

Response samples

Content type
application/json
{
  • "providers": {
    },
  • "profiles": [
    ]
}

Natural person

Returns the data sources available for natural persons.

Responses

Response samples

Content type
application/json
{
  • "providers": {
    },
  • "profiles": [
    ]
}

BusinessRegistry

List registration authorities

Retrieves a list of business registration authorities globally

Responses

Response samples

Content type
application/json
[]

Retrieve registration authority

Retrieves detailed information about a specific registration authority

path Parameters
authorityCode
required
string

Responses

Response samples

Content type
application/json
{
  • "responsibleOrgLocalizedName": "Centre National du Registre du Commerce (CNRC)",
  • "responsibleOrgInternationalName": "National Center of the Trade Register",
  • "authorityCode": "RA000003",
  • "countryCode": "DZ",
  • "country": "Algeria",
  • "localizedName": "Registre du Commerce",
  • "internationalName": "Trade Register",
  • "jurisdiction": "Algeria"
}

Geodata

List countries

Lists all countries in the world with English name and ISO 3166-1 country code

query Parameters
lang
string
Default: "en"

Language for result. Defaults to English

Responses

Response samples

Content type
application/json
[]

Retrieve country info

Retrieves basic geographical information about a country

path Parameters
countryCode
required
string

ISO 3166-1 alpha-2 country code to look up

query Parameters
lang
string
Default: "en"

Language for result. Defaults to English

Responses

Response samples

Content type
application/json
{}

List country subdivisions

Retrieves a list over top level administrative subdivisions for a country with name and ISO 3166-2 region code

path Parameters
countryCode
required
string

ISO 3166-1 alpha-2 country code to look up

query Parameters
lang
string
Default: "en"

Language for result. Defaults to English

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]