Download OpenAPI specification:Download
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.
This API reference provides information on available endpoints and how to interact with them. To learn more about the use cases and the data sources available with Data Verification, visit the conceptual documentation.
If you don't have an account already, sign up for a free Signicat account by completing the following initial preparations:
We recommend you create a sandbox account to test our services before going live. Sandbox and production accounts must be set up separately.
If you require support, you can contact us by creating a support ticket in the Signicat Dashboard.
To connect to the Data Verification API, you need to create an API client and a client secret with the correct permissions in the Signicat Dashboard. To authenticate to the API, you need to complete the following steps:
You are now ready to start connecting to the Data Verification API!
You can learn more about setting up a connection with the API in our Quick start guide.
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.
Learn more about how to authenticate and send your first request to the API in the Obtaining an access token documentation.
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.
Retrieve basic info about an organization
| country required | string ISO 3166-1 country code |
| id required | string Id of the organization |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
{- "name": "SIGNICAT AS",
- "names": [
- {
- "name": "SIGNICAT AS",
- "type": "registered",
- "start": null,
- "end": null
}
], - "organizationNumber": "989584022",
- "vatNumber": "989584022",
- "registrationDate": null,
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}, - "businessAddress": {
- "street": "Gryta 2A",
- "postalCode": "7010",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}, - "addresses": [
- {
- "type": "postal",
- "startDate": null,
- "endDate": null,
- "isActive": true,
- "street": "Postboks 1234",
- "postalCode": "0001",
- "city": "OSLO",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}, - {
- "type": "business",
- "startDate": null,
- "endDate": null,
- "isActive": true,
- "street": "Gryta2A",
- "postalCode": "7010",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}
], - "organizationType": {
- "name": "Aksjeselskap",
- "code": "AS",
}, - "legalStatus": "active",
- "employees": 132,
- "industries": [
- {
- "code": "58.29",
- "description": "Other software publishing",
- "section": "J",
- "level": 4
}
], - "contact": null,
- "metadata": {
- "sources": [
- "no-brreg"
], - "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve ownership info for an organization
| country required | string ISO 3166-1 country code |
| id required | string Id of the organization |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
{- "companies": [
- {
- "name": "SIGNICAT AS",
- "organizationNumber": {
- "domestic": "989584022",
- "dunsNumber": null,
- "legalEntityIdentifier": null
}, - "percentage": 75,
- "percentageRange": null,
- "votingRights": null,
- "votingRightsRange": null
}
], - "persons": [
- {
- "name": {
- "status": "partial",
- "full": "LARS NILSEN",
- "first": null,
- "last": null,
- "middle": null
}, - "dateOfBirth": "0000-00-00",
- "percentage": 25,
- "percentageRange": null,
- "votingRights": null,
- "votingRightsRange": null
}
], - "otherShareholders": null,
- "metadata": {
- "sources": [
- "no-bisnode"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve information about roles in an organization
| country required | string ISO 3166-1 country code |
| id required | string Id of the organization |
| 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 |
| 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 |
{- "persons": [
- {
- "name": {
- "status": "all",
- "full": "SKJEGGESTAD THOMAS",
- "first": "THOMAS",
- "last": "SKJEGGESTAD",
- "middle": null
}, - "address": {
- "street": "KAMFJORDÅSEN 86",
- "postalCode": "3227",
- "city": "SANDEFJORD",
- "country": null
}, - "dateOfBirth": "1956-02-03",
- "nationality": null,
- "identityNumber": null,
- "role": "ceo",
- "roles": [
- {
- "role": "ceo",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}, - {
- "name": {
- "status": "all",
- "full": "LANGLI MAIA ANNE",
- "first": "MAIA",
- "last": "LANGLI",
- "middle": "ANNE"
}, - "address": {
- "street": "EBBESENS GATE 191",
- "postalCode": "1636",
- "city": "FREDRIKSTAD",
- "country": null
}, - "dateOfBirth": "1972-11-17",
- "nationality": null,
- "identityNumber": null,
- "role": "boardLeader",
- "roles": [
- {
- "role": "boardLeader",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}, - {
- "name": {
- "status": "all",
- "full": "SØRHAUG LINE HEDVIG",
- "first": "LINE",
- "last": "SØRHAUG",
- "middle": "HEDVIG"
}, - "address": {
- "street": "HAUGSTUA 204",
- "postalCode": "9017",
- "city": "TROMSØ",
- "country": null
}, - "dateOfBirth": "1965-05-19",
- "nationality": null,
- "identityNumber": null,
- "role": "boardMember",
- "roles": [
- {
- "role": "boardMember",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}, - {
- "name": {
- "status": "all",
- "full": "JULIE BAUDIN",
- "first": "JULIE",
- "last": "BAUDIN",
- "middle": null
}, - "address": {
- "street": "UTVANDRET",
- "postalCode": null,
- "city": null,
- "country": null
}, - "dateOfBirth": "1966-03-22",
- "nationality": null,
- "identityNumber": null,
- "role": "boardMember",
- "roles": [
- {
- "role": "boardMember",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}
], - "companies": [
- {
- "name": "Ernst & Young AS",
- "organizationNumber": {
- "domestic": "976389387",
- "dunsNumber": null,
- "legalEntityIdentifier": null
}, - "role": "accountant",
- "roles": [
- {
- "role": "accountant",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}, - {
- "name": "AZETS INSIGHT AS",
- "organizationNumber": {
- "domestic": "983338917",
- "dunsNumber": null,
- "legalEntityIdentifier": null
}, - "role": "bookkeeper",
- "roles": [
- {
- "role": "bookkeeper",
- "startDate": null,
- "endDate": null,
- "description": null
}
]
}
], - "others": null,
- "metadata": {
- "sources": [
- "no-bisnode"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve information about ultimate beneficial owners for an organization
| country required | string ISO 3166-1 country code |
| id required | string Id of the organization |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
{- "ultimateBeneficiaryOwners": [
- {
- "ownership": {
- "directOwnership": 100,
- "directOwnershipRange": null,
- "indirectOwnership": null,
- "indirectOwnershipRange": null,
- "integratedOwnership": null,
- "integratedOwnershipRange": null,
- "votingRights": null,
- "votingRightsRange": null,
- "votingPower": null,
- "votingPowerRange": null
}, - "name": {
- "status": "partial",
- "full": "HANNESTAD MARIE GRETE",
- "first": null,
- "last": null,
- "middle": null
}, - "address": {
- "street": "REDDALSVEIEN 146",
- "postalCode": "4886",
- "city": "GRIMSTAD",
- "country": null
}, - "birth": {
- "monthOfBirth": "04",
- "yearOfBirth": "1960",
- "dateOfBirth": "1960-04-03",
- "country": null
}, - "gender": "unknown",
- "identityNumber": null,
- "nationality": null,
- "role": "unknown"
}
], - "metadata": {
- "sources": [
- "no-bisnode"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve financial info for an organization
| country required | string ISO 3166-1 country code |
| id required | string Id of the organization |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
{- "creditRating": {
- "score": "AAA",
- "ratingSystem": "Bisnode AAA",
- "description": "Highest credit worthiness",
- "year": 2020
}, - "numberOfPaymentRemarks": 0,
- "profitAndLoss": [
- {
- "turnover": 231750000,
- "grossProfit": 8305000,
- "netProfit": -2706000,
- "netProfitAfterTax": null,
- "year": 2019,
- "currency": "SEK"
}, - {
- "turnover": 231750000,
- "grossProfit": 8305000,
- "netProfit": -2706000,
- "netProfitAfterTax": null,
- "year": 2018,
- "currency": "SEK"
}, - {
- "turnover": 231750000,
- "grossProfit": 8305000,
- "netProfit": -2706000,
- "netProfitAfterTax": null,
- "year": 2017,
- "currency": "SEK"
}
], - "netWorth": [ ],
- "metadata": {
- "sources": [
- "bisnode"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.
| country required | string ISO 3166-1 country code |
| accountNumber required | string Account number of the organization |
| idList | Array of strings Parameter used to specify a list of id checks. Allowed values are |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
{- "AccountNumber": "string",
- "IsValidAccountNumber": true,
- "ValidationDetails": [
- {
- "IsMatching": true,
- "MatchType": "unknown",
- "Description": "string"
}
], - "Country": {
- "Name": "string",
- "Alpha2": "string",
- "Alpha3": "string",
- "Numeric": "string"
}, - "AccountDetails": {
- "AccountType": "unknown",
- "AccountStatus": "unknown",
- "IsJoinedAccount": true,
- "NumberOfHolders": 0,
- "Foreign": true,
- "CountryOfAccount": {
- "Name": "string",
- "Alpha2": "string",
- "Alpha3": "string",
- "Numeric": "string"
}
}, - "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| offset | integer <int32> Used for paging |
| limit | integer <int32> Set how many results you want per page (max/default 100) |
{- "offset": 0,
- "limit": 100,
- "size": 1,
- "links": {
- "next": null,
- "previous": null,
- "self": null
}, - "data": [
- {
- "entityType": "organization",
- "listType": "sanction",
- "matchStrength": {
- "score": 20,
- "certainty": "low"
}, - "sourceName": "SCREENING_SOURCE",
- "name": {
- "status": "partial",
- "full": "OrgName AB",
- "first": null,
- "last": null,
- "middle": null
}, - "gender": "unknown",
- "aliases": [
- {
- "status": "partial",
- "full": "OrgName AB",
- "first": null,
- "last": null,
- "middle": null
}
], - "associates": [ ],
- "datesOfBirth": [ ],
- "addresses": [
- {
- "street": "Hålebäcksvägen 7",
- "postalCode": "79026",
- "city": "ENVIKEN",
- "country": {
- "name": null,
- "alpha2": "SE",
- "alpha3": "SWE",
- "numeric": "752"
}
}
], - "comments": [ ],
- "functions": [ ],
- "roles": [
- {
- "roleType": "Type of role",
- "organization": "Organization Name",
- "description": "Role description",
- "startDate": null,
- "endDate": null
}
]
}
], - "metadata": {
- "sources": [
- "trapets"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Search for an organization.
Remarks when searching multiple sources:
Functionality is subject to change without prior notice.
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 | integer <int32> Used for paging |
| limit | integer <int32> Set how many results you want per page (max/default 100) |
{- "offset": 0,
- "limit": 100,
- "size": 1,
- "links": {
- "next": null,
- "previous": null,
}, - "data": [
- {
- "organizationNumber": "989584022",
- "taxNumber": "832879",
- "externalId": "NO989584022",
- "name": "SIGNICAT AS",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}, - "address": null
}
], - "metadata": {
- "sources": [
- "no-brreg",
- "opencorporates"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Provides the link to download the documents(Registration, UBO map, Ownership map, Shareholders) from data registers.
| id | string A unique identifier for the organization |
| country | string Country where the organisation is located. |
| name | string Optional filter for the organization name |
| documentType | string (DocumentType) Enum: "basic" "shareholder" "registration" "financial" "tax" "ownership" "ubo" "board" "historical" "registerextract" "other" "groupstructure" Specifies the type of document to retrieve |
| deliveryMethod | string (DeliveryMethod) Value: "base64" Delivery method of the document |
| 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",
- "Name": "string",
- "Document": {
- "FileName": "string",
- "Type": "string",
- "Delivery": {
- "ContentType": "string",
- "Url": "string",
- "Method": "string",
- "Content": "string"
}
}, - "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}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.
Retrieve basic info about a person
| country required | string ISO 3166-1 country code |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "names": [
- {
- "isActive": true,
- "startDate": "1997-03-04T12:30:00.000Z",
- "endDate": null,
- "status": "all",
- "full": "Esther Kristin Hall",
- "first": "Esther",
- "last": "Hall",
- "middle": "Kristin"
}
], - "birth": {
- "location": "TØNSBERG",
- "monthOfBirth": "March",
- "yearOfBirth": "1997",
- "dateOfBirth": "1997-03-02",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}, - "death": {
- "isDead": true,
- "monthOfDeath": "04",
- "yearOfDeath": "2017",
- "dateOfDeath": "2017-04-09"
}, - "nationalities": [
- {
- "isActive": true,
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}, - "startDate": "1997-03-04T12:30:00.000Z",
- "endDate": null
}
], - "citizenships": null,
- "permanentAddresses": [
- {
- "isActive": true,
- "isConfidential": true,
- "startDate": "2018-08-02T12:30:00.000Z",
- "endDate": null,
- "addressLines": null,
- "street": "Tistelvegen 207",
- "postalCode": "7033",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}
], - "postalAddresses": [
- {
- "isActive": true,
- "isConfidential": true,
- "startDate": "2018-08-02T12:30:00.000Z",
- "endDate": null,
- "addressLines": null,
- "street": "Tistelvegen 207",
- "postalCode": "7033",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}
], - "foreignAddresses": [ ],
- "metadata": {
- "sources": [
- "no-infotorg-dsf"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve address info for a person. This endpoint is deprecated, use Basic instead.
| country required | string ISO 3166-1 country code |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "permanent": {
- "street": "Tors veg 30 C",
- "postalCode": "7035",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}, - "postal": {
- "street": "Mjølnervegen 6",
- "postalCode": "7035",
- "city": "TRONDHEIM",
- "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}, - "foreign": null,
- "metadata": {
- "sources": [
- "no-freg"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve finance info for a person
| country required | string ISO 3166-1 country code |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "creditScore": {
- "score": "4",
- "scoringSystem": "Bisnode AAA",
- "link": null,
- "year": null
}, - "numberOfPaymentRemarks": 1,
- "incomeAndWealth": [
- {
- "year": 2019,
- "currency": "NOK",
- "grossIncome": 302461,
- "netIncome": 164092,
- "wealth": 102002
}, - {
- "year": 2018,
- "currency": "NOK",
- "grossIncome": null,
- "netIncome": 131897,
- "wealth": 90675
}
], - "metadata": {
- "sources": [
- "bisnode"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}Retrieve contacts for a person
| country required | string ISO 3166-1 country code |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "Contacts": [
- {
- "Email": "string",
- "Phone": "string",
- "PreferredLanguage": "string"
}
], - "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}Verification of a person identity
| country required | string ISO 3166-1 country code |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "Status": "notidentified",
- "Description": "string",
- "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.
| country required | string ISO 3166-1 country code |
| accountNumber required | string Account number of the person |
| idType | string Optional hint to what kind of id being used.
Allowed values are |
| 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 |
| 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 |
{- "AccountNumber": "string",
- "IsValidAccountNumber": true,
- "ValidationDetails": [
- {
- "IsMatching": true,
- "MatchType": "unknown",
- "Description": "string"
}
], - "Country": {
- "Name": "string",
- "Alpha2": "string",
- "Alpha3": "string",
- "Numeric": "string"
}, - "AccountDetails": {
- "AccountType": "unknown",
- "AccountStatus": "unknown",
- "IsJoinedAccount": true,
- "NumberOfHolders": 0,
- "Foreign": true,
- "CountryOfAccount": {
- "Name": "string",
- "Alpha2": "string",
- "Alpha3": "string",
- "Numeric": "string"
}
}, - "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}Search for an person. Functionality is subject to change without prior notice.
| dateOfBirth | string <= 10 characters Date of birth of the entity to search for, accepted formats: |
| 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) |
{- "offset": 0,
- "limit": 100,
- "size": 1,
- "links": {
- "next": null,
- "previous": null,
- "first": null,
- "self": null
}, - "data": [
- {
- "id": null,
- "name": {
- "status": "partial",
- "full": "Example Full Name",
- "first": null,
- "last": null,
- "middle": null
}, - "country": {
- "name": null,
- "alpha2": "NO",
- "alpha3": "NOR",
- "numeric": "578"
}
}
], - "metadata": {
- "sources": [
- "no-freg",
- "fi-dvv"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.
| dateOfBirth | string <= 10 characters Date of birth of the entity to search for, accepted formats: |
| 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 |
| offset | integer <int32> Used for paging |
| limit | integer <int32> Set how many results you want per page (max/default 100) |
{- "offset": 0,
- "limit": 100,
- "size": 1,
- "links": {
- "next": null,
- "previous": null,
- "self": null
}, - "data": [
- {
- "entityType": "organization",
- "listType": "sanction",
- "matchStrength": {
- "score": 20,
- "certainty": "low"
}, - "sourceName": "SCREENING_SOURCE",
- "name": {
- "status": "partial",
- "full": "OrgName AB",
- "first": null,
- "last": null,
- "middle": null
}, - "gender": "unknown",
- "aliases": [
- {
- "status": "partial",
- "full": "OrgName AB",
- "first": null,
- "last": null,
- "middle": null
}
], - "associates": [ ],
- "datesOfBirth": [ ],
- "addresses": [
- {
- "street": "Hålebäcksvägen 7",
- "postalCode": "79026",
- "city": "ENVIKEN",
- "country": {
- "name": null,
- "alpha2": "SE",
- "alpha3": "SWE",
- "numeric": "752"
}
}
], - "comments": [ ],
- "functions": [ ],
- "roles": [
- {
- "roleType": "Type of role",
- "organization": "Organization Name",
- "description": "Role description",
- "startDate": null,
- "endDate": null
}
]
}
], - "metadata": {
- "sources": [
- "trapets"
], - "urls": [ ],
- "lastChanged": null,
- "rawJson": null,
- "isCache": false
}
}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.
{- "providers": {
- "global": [
- {
- "id": "3b69a782-2c28-4fb2-b27e-5b3c14743b3d",
- "profiles": [
- "screening"
], - "name": "trapets",
- "officialName": "Trapets",
- "description": "PEP and Sanction screening against Trapets InstantWatch KYC"
}
], - "no": [
- {
- "id": "221a4e31-11fb-417b-a9dc-ee49bd630f6c",
- "profiles": [
- "ownership",
- "ubo",
- "roles"
], - "name": "no-bisnode",
- "officialName": "Bisnode Norway",
- "description": "Provides data from bisnode"
}, - {
- "id": "97dd9017-cdc5-4f32-b937-1ce57815ba6d",
- "profiles": [
- "basic",
- "authorization"
], - "name": "no-brreg",
- "officialName": "Brønnøysundregistrene (BRREG) Norway",
- "description": "Provides data from brreg"
}
], - "fi": [
- {
- "id": "17066a39-74af-4c61-a6c9-d2f490ad2dd9",
- "profiles": [
- "basic"
], - "name": "fi-prh",
- "officialName": "PRH Finland",
- "description": "Prh organization lookup"
}, - {
- "id": "32747ec3-aee2-44d8-b6c0-ffeec3430d50",
- "profiles": [
- "ubo",
- "roles",
- "authorization"
], - "name": "fi-bisnode",
- "officialName": "Bisnode Finland",
- "description": "Bisnode Finland companies API"
}, - {
- "id": "2e657179-83f9-4ea8-9306-4744a5c50257",
- "profiles": [
- "ownership",
- "roles"
], - "name": "fi-asiakastieto",
- "officialName": "Asiakastieto Finland",
- "description": "Asiakastieto organization lookup"
}
], - "se": [
- {
- "id": "995934e9-766c-48b0-ac8f-3a870f7cb54c",
- "profiles": [
- "basic",
- "ubo",
- "roles",
- "authorization"
], - "name": "se-bolagsverket",
- "officialName": "Bolagsverket Sweden",
- "description": "Provides data from Bolagsverket"
}
], - "be": [
- {
- "id": "c355866a-67c5-4c38-bfd3-9b5303d9c9e8",
- "profiles": [
- "basic",
- "roles"
], - "name": "be-databe",
- "officialName": "Data.be/KBO Belgium",
- "description": "Databe organization lookup"
}, - {
- "id": "a1b7fc00-7fbe-4427-b7ee-9b98ff458690",
- "profiles": [
- "basic"
], - "name": "dk-cvr",
- "officialName": "CVR (Det Centrale Virksomhedsregister)",
- "description": "Provides data from CVR - det Centrale Virk"
}
]
}, - "profiles": [
- "authorization",
- "basic",
- "finance",
- "ownership",
- "roles",
- "screening",
- "ubo"
]
}{- "providers": {
- "no": [
- {
- "id": "a76fc04c-0c7c-488b-b138-07c1ccb7ad2e",
- "profiles": [
- "address"
], - "name": "no-freg",
- "officialName": "Folkeregisteret Norway",
- "description": "Norwegian population registry lookup"
}, - {
- "id": "e09bf673-15b3-4c5c-b713-8145e8a418dc",
- "profiles": [
- "address"
], - "name": "no-infotorg-dsf",
- "officialName": "Infotorg DSF",
- "description": "Norwegian population registry lookup through Infotorg"
}
], - "fi": [
- {
- "id": "815cfd0b-f587-40cb-9782-60ec2dd4323d",
- "profiles": [
- "address"
], - "name": "fi-dvv",
- "officialName": "DVV Finland",
- "description": "Dvv person lookup"
}
], - "se": [
- {
- "id": "56103e78-0da1-41bd-a8a9-f776d44a213e",
- "profiles": [
- "address"
], - "name": "se-spar",
- "officialName": "SPAR (Statens Personadressregister)",
- "description": "Statens Personadressregister lookup"
}
], - "dk": [
- {
- "id": "5ea4c5f6-740d-4621-8c31-be4a1858580c",
- "profiles": [
- "address"
], - "name": "dk-cpr",
- "officialName": "CPR Denmark",
- "description": "Provides data from CPR - Det Centrale Personregister"
}
]
}, - "profiles": [
- "address"
]
}{- "Providers": {
- "property1": [
- {
- "Id": "string",
- "Profiles": [
- "string"
], - "Name": "string",
- "OfficialName": "string",
- "Description": "string"
}
], - "property2": [
- {
- "Id": "string",
- "Profiles": [
- "string"
], - "Name": "string",
- "OfficialName": "string",
- "Description": "string"
}
]
}, - "Profiles": [
- "string"
]
}Retrieve risk of fraud
string The email address to be checked for risk. | |
| phoneNumber | string The phone number to be checked for risk. |
| ipAddress | string The IP address to be checked for risk. |
| country | string Country connected with the phoneNumber. ISO 3166-1 country code. This is an optional parameter and usage would depend on the source. |
| 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 |
{- "Email": {
- "Valid": true,
- "RiskScore": 0.1,
- "IsDeliverable": true,
- "Age": 0.1,
- "Domain": {
- "Name": "string",
- "CreatedDate": "2019-08-24T14:15:22Z",
- "IsDisposable": true
}, - "Remarks": [
- "string"
]
}, - "PhoneNumber": {
- "Valid": true,
- "RiskScore": 0.1,
- "IsDisposable": true,
- "Type": "mobile",
- "Carrier": "string",
- "Country": "string",
- "Remarks": [
- "string"
]
}, - "IpAddress": {
- "IsRisky": true,
- "RiskScore": 0.1,
- "LastSeenDays": 0,
- "Vpn": true,
- "GeoLocation": {
- "Country": "string",
- "Region": "string",
- "City": "string"
}, - "Remarks": [
- "string"
]
}, - "Metadata": {
- "Sources": [
- "string"
], - "Urls": [
- "string"
], - "LastChanged": "2019-08-24T14:15:22Z",
- "RawJson": "string",
- "IsCache": true
}
}Retrieves a list of business registration authorities globally
[- {
- "authorityCode": "RA000071",
- "countryCode": "CM",
- "country": "Cameroon",
- "localizedName": "Planning and Regional De…t (Ministry of Economy)",
- "internationalName": "Planning and Regional De…t (Ministry of Economy)",
- "jurisdiction": "Cameroon"
}, - {
- "authorityCode": "RA000201",
- "countryCode": "DE",
- "country": "Germany",
- "localizedName": "Handelsregister",
- "internationalName": "Commercial Register",
- "jurisdiction": "Ansbach"
}
]Retrieves detailed information about a specific registration authority
| authorityCode required | string |
{- "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"
}Lists all countries in the world with English name and ISO 3166-1 country code
| lang | string Default: "en" Language for result. Defaults to English |
[- {
- "countryCode": "AD",
- "countryName": "Andorra",
- "isoAlpha3": "AND",
- "isoNumeric": "020"
}, - {
- "countryCode": "BG",
- "countryName": "Bulgaria",
- "isoAlpha3": "BGR",
- "isoNumeric": "100"
}, - {
- "countryCode": "CH",
- "countryName": "Switzerland",
- "isoAlpha3": "CHE",
- "isoNumeric": "756"
}
]Retrieves basic geographical information about a country
| countryCode required | string ISO 3166-1 alpha-2 country code to look up |
| lang | string Default: "en" Language for result. Defaults to English |
{- "subdivisions_url": "https://api.signicat.com/info/lookup/geodata/countries/AD/subdivisions?lang=en",
- "continent": "EU",
- "capital": "Andorra la Vella",
- "languages": [
- "ca"
], - "population": "77006",
- "countryCode": "AD",
- "isoAlpha3": "AND",
- "countryName": "Andorra",
- "continentName": "Europe",
- "currencyCode": "EUR",
- "isoNumeric": "020"
}Retrieves a list over top level administrative subdivisions for a country with name and ISO 3166-2 region code
| countryCode required | string ISO 3166-1 alpha-2 country code to look up |
| lang | string Default: "en" Language for result. Defaults to English |
[- {
- "name": "Andorra la Vella",
- "isoCode": "07"
}, - {
- "name": "La Massana",
- "isoCode": "04"
}, - {
- "name": "Ordino",
- "isoCode": "05"
}, - {
- "name": "Sant Julià de Loria",
- "isoCode": "06"
}, - {
- "name": "Canillo",
- "isoCode": "02"
}, - {
- "name": "Escaldes-Engordany",
- "isoCode": "08"
}, - {
- "name": "Encamp",
- "isoCode": "03"
}
]