{ "openapi": "3.0.4", "info": { "title": "Signicat Data Verification API", "description": "\n- **Base URL**: `https://api.signicat.com/info/lookup/`\n- **Documentation**: See the [Data Verification](/docs/data-verification/) developer documentation.\n- **Support**: [Create a support ticket](https://dashboard.signicat.com/contact-us/tickets/) in the Signicat Dashboard.\n\n# Introduction\n\nThe 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.\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the use cases and available data sources, see our [Data Verification developer documentation](/docs/data-verification/).\n\nThis REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.\n\n# Get started\n\nBefore you can start making requests to this API, you need to learn how to connect to it. To do this, see the [Quick start guide](/docs/data-verification/quick-start/).\n\n# Using this API\n\n## Audit logs\n\nUse the Signicat **Audit logs** service to see documented evidence of the sequence of activities that have affected a system.\n\n- Access it: **Signicat Dashboard** > **Settings** > [**Audit logs**](https://dashboard.signicat.com/audit)\n- For information generic to all Signicat audit logs, see the general [Audit logs](/docs/audit-logs/) documentation.\n\n## Errors\n\nWhen you make an API call to Signicat and an error occurs, you will receive a response message with an error code.\n\n- For errors generic to all Signicat APIs, see the general [Error codes](/docs/error-codes/) documentation.\n- For errors specific to this service, see the Data Verification [Error codes](/docs/data-verification/error-codes/) documentation.\n\n## Events (callback)\n\nUse the Signicat **Events** service to automatically receive information about when something happens in one of our services into your system.\n\n- Access it: Go to **Signicat Dashboard** > **Settings** > [**Events**](https://dashboard.signicat.com/events)\n- For information generic to all Signicat events, see the general [Events](/docs/events/) documentation.\n\n> **Note**: This is often referred to as callback.\n", "contact": "", "version": "v1", "license": "", "termsOfService": "" }, "servers": [ { "url": "https://api.signicat.com/info/lookup" } ], "tags": [ { "name": "Organizations", "description": "\nThis API returns information about an organization. \n\nLearn more about the different data sources in the [developer documentation](https://developer.signicat.com/docs/data-verification/data-sources/).\nAlso, refer to Sources section (below) to learn how to configure the data sources which you would like to use.\n" }, { "name": "Persons", "description": "\nThis API returns information about a person. \n\nLearn more about the different data sources in the [developer documentation](https://developer.signicat.com/docs/data-verification/data-sources/). \nAlso, refer to Sources section (below) to learn how to configure the data sources which you would like to use.\n" }, { "name": "Sources", "description": "\nContains information about the different sources used by the API.\n\nIt 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.\n{\n \"ver\": 1,\n \"rules\": [\n {\n \"scope\": [\n \"basic\",\n ],\n \"sources\": [\n \"nameOfSource\"\n ]\n }\n ],\n \"strict\": true\n}\n\nIf the source is specified by query parameter for a request, this will be used instead of any header.\n" }, { "name": "AccountsAndAttributes", "description": "\nThis API returns information about a account. \n\nLearn more about the different data sources in the [developer documentation](https://developer.signicat.com/docs/data-verification/data-sources/). \nAlso, refer to Sources section (below) to learn how to configure the data sources which you would like to use.\n" }, { "name": "BusinessRegistry", "description": " This API returns information about a business registry." }, { "name": "Geodata", "description": " This API returns information about geo data." } ], "paths": { "/accountsAndAttributes/fraudRisk": { "get": { "tags": [ "AccountsAndAttributes" ], "summary": "Fraud Risk", "description": "Retrieve risk of fraud", "operationId": "AccountsAndAttributes_GetFraudRisk_GET", "parameters": [ { "name": "email", "in": "query", "description": "The email address to be checked for risk.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "The phone number to be checked for risk.", "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "description": "The IP address to be checked for risk.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country connected with the phoneNumber. ISO 3166-1 country code. This is an optional parameter and usage would depend on the source.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Risk of Fraud was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountsAndAttributes.FraudRiskDto" } } } }, "400": { "description": "Request has errors" }, "401": { "description": "Unauthorized to do the request" }, "403": { "description": "Forbidden to do the request" }, "404": { "description": "No risk of fraud was found" } } } }, "/businessregistry": { "get": { "tags": [ "BusinessRegistry" ], "summary": "List registration authorities", "description": "Retrieves a list of business registration authorities globally", "operationId": "BusinessRegistry_ListRegistrationAuthorities_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRegistry.RegistrationAuthorityItemDto" } }, "example": [ { "self_url": "https://api.signicat.com/info/lookup/businessregistry/RA000071", "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" }, { "self_url": "https://api.signicat.com/info/lookup/businessregistry/RA000201", "authorityCode": "RA000201", "countryCode": "DE", "country": "Germany", "localizedName": "Handelsregister", "internationalName": "Commercial Register", "jurisdiction": "Ansbach" } ] } } } } } }, "/businessregistry/{authorityCode}": { "get": { "tags": [ "BusinessRegistry" ], "summary": "Retrieve registration authority", "description": "Retrieves detailed information about a specific registration authority", "operationId": "BusinessRegistry_GetRegistrationAuthorityByAuthorityCode_GET", "parameters": [ { "name": "authorityCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.RegistrationAuthorityDto" }, "example": { "responsibleOrgLocalizedName": "Centre National du Registre du Commerce (CNRC)", "responsibleOrgInternationalName": "National Center of the Trade Register", "website": "https://sidjilcom.cnrc.dz/web/cnrc/accueil", "authorityCode": "RA000003", "countryCode": "DZ", "country": "Algeria", "localizedName": "Registre du Commerce", "internationalName": "Trade Register", "jurisdiction": "Algeria" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/geodata/countries": { "get": { "tags": [ "Geodata" ], "summary": "List countries", "description": "Lists all countries in the world with English name and ISO 3166-1 country code", "operationId": "Geodata_ListCountries_GET", "parameters": [ { "name": "lang", "in": "query", "description": "Language for result. Defaults to English", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Geodata.CountryListItemDto" } }, "example": [ { "self_url": "https://api.signicat.com/info/lookup/geodata/countries/AD?lang=en", "countryCode": "AD", "countryName": "Andorra", "isoAlpha3": "AND", "isoNumeric": "020" }, { "self_url": "https://api.signicat.com/info/lookup/geodata/countries/BG?lang=en", "countryCode": "BG", "countryName": "Bulgaria", "isoAlpha3": "BGR", "isoNumeric": "100" }, { "self_url": "https://api.signicat.com/info/lookup/geodata/countries/CH?lang=en", "countryCode": "CH", "countryName": "Switzerland", "isoAlpha3": "CHE", "isoNumeric": "756" } ] } } } } } }, "/geodata/countries/{countryCode}": { "get": { "tags": [ "Geodata" ], "summary": "Retrieve country info", "description": "Retrieves basic geographical information about a country", "operationId": "Geodata_GetCountryInfo_GET", "parameters": [ { "name": "countryCode", "in": "path", "description": "ISO 3166-1 alpha-2 country code to look up", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "Language for result. Defaults to English", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Geodata.CountryInfoDto" }, "example": { "self_url": "https://api.signicat.com/info/lookup/geodata/countries/AD?lang=en", "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" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/geodata/countries/{countryCode}/subdivisions": { "get": { "tags": [ "Geodata" ], "summary": "List country subdivisions", "description": "Retrieves a list over top level administrative subdivisions for a country with name and ISO 3166-2 region code", "operationId": "Geodata_ListCountrySubdivisions_GET", "parameters": [ { "name": "countryCode", "in": "path", "description": "ISO 3166-1 alpha-2 country code to look up", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "Language for result. Defaults to English", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Geo.DivisionListItem" } }, "example": [ { "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" } ] } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}": { "get": { "tags": [ "Organizations" ], "summary": "Basic", "description": "Retrieve basic info about an organization", "operationId": "Organization_GetBasicOrganizationInfo_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.BasicInfoDto" }, "example": { "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", "url": "https://data.brreg.no/enhetsregisteret/api/organisasjonsformer" }, "legalStatus": "active", "employees": 132, "industries": [ { "code": "58.29", "description": "Other software publishing", "section": "J", "level": 4 } ], "contact": { "phone": { "nationalNumber": "1283", "countryCode": 1, "intlFormat": "+1 1283" }, "email": "example@example.com" }, "metadata": { "sources": [ "no-brreg" ], "urls": [ "https://data.brreg.no/enhetsregisteret/api/enheter/989584022" ], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}/authorization": { "get": { "tags": [ "Organizations" ], "summary": "Authorization", "description": "This endpoint returns which people are allowed to sign and act on behalf of an organization.\n \nIf 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.\n The API will report if it was able to calculate all combinations, only a part of the possible combinations, or no combinations.\n The API will also return a list of the individual people with signing rights and their respective roles.", "operationId": "Organization_GetAuthorization_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.AuthorizationDto" }, "example": { "signature": { "status": "complete", "description": "Styret i fellesskap, Styrets leder alene", "combinations": [ { "signers": [ { "name": { "status": "partial", "full": "Anne Marie Dahl", "first": null, "last": null, "middle": null }, "dateOfBirth": "1970-04-02", "role": { "code": "boardLeader", "description": "Styrets leder" }, "identityNumber": { "idNumber": "123432", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } }, { "name": { "status": "partial", "full": "Lars Nilsen", "first": null, "last": null, "middle": null }, "dateOfBirth": "1983-10-26", "role": { "code": "boardMember", "description": "Styremedlem" }, "identityNumber": { "idNumber": "123431", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } }, { "name": { "status": "partial", "full": "Kari Elisabeth Strand", "first": null, "last": null, "middle": null }, "dateOfBirth": "1988-07-07", "role": { "code": "boardMember", "description": "Styremedlem" }, "identityNumber": { "idNumber": "12343234", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ], "description": "Styret i fellesskap" }, { "signers": [ { "name": { "status": "partial", "full": "Anne Marie Dahl", "first": null, "last": null, "middle": null }, "dateOfBirth": "1970-04-02", "role": { "code": "boardLeader", "description": "Styrets leder" }, "identityNumber": { "idNumber": "123423", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ], "description": "Styrets leder alene" } ], "basis": { "people": [ { "name": { "status": "partial", "full": "Anne Marie Dahl", "first": null, "last": null, "middle": null }, "dateOfBirth": "1970-04-02", "role": { "code": "boardLeader", "description": "Styrets leder" }, "roles": [ { "code": "boardLeader", "description": "Styrets leder" } ], "identityNumber": { "idNumber": "4535456", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } }, { "name": { "status": "partial", "full": "Lars Nilsen", "first": null, "last": null, "middle": null }, "dateOfBirth": "1983-10-26", "role": { "code": "boardMember", "description": "Styremedlem" }, "roles": [ { "code": "boardMember", "description": "Styremedlem" } ], "identityNumber": { "idNumber": "64564564", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } }, { "name": { "status": "partial", "full": "Kari Elisabeth Strand", "first": null, "last": null, "middle": null }, "dateOfBirth": "1983-07-07", "role": { "code": "boardMember", "description": "Styremedlem" }, "roles": [ { "code": "boardMember", "description": "Styremedlem" } ], "identityNumber": { "idNumber": "3242343", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } }, { "name": { "status": "partial", "full": "Øystein Magnus Haugen", "first": null, "last": null, "middle": null }, "dateOfBirth": "1980-05-01", "role": { "code": "ceo", "description": "Daglig leder/administrerende direktør" }, "roles": [ { "code": "ceo", "description": "Daglig leder/administrerende direktør" } ], "identityNumber": { "idNumber": "7686876", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ] }, "metadata": { "sources": [ "no-brreg" ], "urls": [ "https://data.brreg.no/enhetsregisteret/api/enheter/989584022" ], "lastChanged": null, "rawJson": null } }, "powerOfProcuration": { "status": "complete", "description": "Daglig leder alene", "combinations": [ { "signers": [ { "name": { "status": "partial", "full": "Øystein Magnus Haugen", "first": null, "last": null, "middle": null }, "dateOfBirth": "1980-05-01", "role": { "code": "ceo", "description": "Daglig leder/administrerende direktør" }, "identityNumber": { "idNumber": "7686786", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ], "description": "Daglig leder alene" } ], "basis": { "people": [ { "name": { "status": "partial", "full": "Øystein Magnus Haugen", "first": null, "last": null, "middle": null }, "dateOfBirth": "1980-05-01", "role": { "code": "ceo", "description": "Daglig leder/administrerende direktør" }, "roles": [ { "code": "ceo", "description": "Daglig leder/administrerende direktør" } ], "identityNumber": { "idNumber": "7686876", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ] }, "metadata": { "sources": [ "no-brreg" ], "urls": [ "https://data.brreg.no/enhetsregisteret/api/enheter/989584022/prokura" ], "lastChanged": null, "rawJson": null } }, "metadata": { "accountingYear": null, "sources": [ "no-brreg" ], "urls": [ "https://data.brreg.no/fullmakt/enheter/989584022/prokura", "https://data.brreg.no/fullmakt/enheter/989584022/signatur" ], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}/ownership": { "get": { "tags": [ "Organizations" ], "summary": "Ownership", "description": "Retrieve ownership info for an organization", "operationId": "Organization_GetOwnership_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.OwnershipDto" }, "example": { "companies": [ { "name": "SIGNICAT AS", "organizationNumber": { "domestic": "989584022", "dunsNumber": null, "legalEntityIdentifier": null }, "percentage": 75, "percentageRange": { "from": 10, "to": 75 }, "votingRights": 2, "votingRightsRange": { "from": 0.1, "to": 2 }, "integratedOwnership": 0.2, "integratedOwnershipRange": { "from": 0.1, "to": 0.2 }, "sourceSpecific": null } ], "persons": [ { "name": { "status": "partial", "full": "LARS NILSEN", "first": null, "last": null, "middle": null }, "dateOfBirth": "0000-00-00", "percentage": 25, "percentageRange": { "from": 1, "to": 25 }, "votingRights": 2, "votingRightsRange": { "from": 0.1, "to": 2 }, "integratedOwnership": 10.1, "integratedOwnershipRange": { "from": 0.1, "to": 10.1 }, "sourceSpecific": null } ], "otherShareholders": [ { "name": "SIGNICAT AS", "id": "12345", "percentage": 75, "percentageRange": { "from": 10, "to": 75 }, "votingRights": 2, "votingRightsRange": { "from": 0.1, "to": 2 }, "integratedOwnership": 0.2, "integratedOwnershipRange": { "from": 0.1, "to": 0.2 }, "sourceSpecific": null } ], "sourceSpecific": null, "metadata": { "sources": [ "no-bisnode" ], "urls": [], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}/roles": { "get": { "tags": [ "Organizations" ], "summary": "Roles", "description": "Retrieve information about roles in an organization", "operationId": "Organization_GetRoles_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Optionally request one or more attributes, by default all available attributes are included.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.RolesDto" }, "example": { "persons": [ { "name": { "status": "all", "full": "SKJEGGESTAD THOMAS", "first": "THOMAS", "last": "SKJEGGESTAD", "middle": null }, "address": { "street": "KAMFJORDÅSEN 86", "postalCode": "3227", "city": "SANDEFJORD", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "dateOfBirth": "1956-02-03", "nationality": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "identityNumber": { "idNumber": "21213", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "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": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "dateOfBirth": "1972-11-17", "nationality": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "identityNumber": { "idNumber": "21213", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "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": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "dateOfBirth": "1965-05-19", "nationality": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "identityNumber": { "idNumber": "21213", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "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": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "dateOfBirth": "1966-03-22", "nationality": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "identityNumber": { "idNumber": "12342234", "type": "nationalIdentityNumber", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}/ultimate-beneficial-owners": { "get": { "tags": [ "Organizations" ], "summary": "Ultimate beneficial owners", "description": "Retrieve information about ultimate beneficial owners for an organization", "operationId": "Organization_GetUbo_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ultimate beneficial owners was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.UboDto" }, "example": { "ultimateBeneficiaryOwners": [ { "ownership": { "directOwnership": 100, "directOwnershipRange": { "from": 5, "to": 100 }, "indirectOwnership": null, "indirectOwnershipRange": { "from": 1, "to": 2.5 }, "integratedOwnership": null, "integratedOwnershipRange": { "from": 10, "to": 20 }, "votingRights": null, "votingRightsRange": { "from": 50, "to": 55 }, "votingPower": null, "votingPowerRange": { "from": 90, "to": 90.5 } }, "name": { "status": "partial", "full": "HANNESTAD MARIE GRETE", "first": null, "last": null, "middle": null }, "address": { "street": "REDDALSVEIEN 146", "postalCode": "4886", "city": "GRIMSTAD", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "birth": { "monthOfBirth": "04", "yearOfBirth": "1960", "dateOfBirth": "1960-04-03", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "gender": "unknown", "identityNumber": { "idNumber": "21213", "type": "unknown", "country": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } }, "nationality": { "name": "Norway", "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "role": "unknown" } ], "metadata": { "sources": [ "no-bisnode" ], "urls": [], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "No ultimate beneficial owners was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/{id}/finance": { "get": { "tags": [ "Organizations" ], "summary": "Finance", "description": "Retrieve financial info for an organization", "operationId": "Organization_GetFinance_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.FinanceDto" }, "example": { "creditRating": { "score": "AAA", "ratingSystem": "Bisnode AAA", "description": "Highest credit worthiness", "link": "https://www.bisnode.com/about-bisnode/what-we-do/our-approach-to-risk-and-credit/credit-rating-model-company/", "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/organizations/accountnumber/{accountNumber}/verify": { "get": { "tags": [ "Organizations" ], "summary": "Account Holder Verification", "description": "Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.", "operationId": "Organization_VerifyAccountNumber_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "accountNumber", "in": "path", "description": "Account number of the organization", "required": true, "schema": { "type": "string" } }, { "name": "idList", "in": "query", "description": "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", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax`, `external`, `IBAN` and `branch`, defaults to `organization` or `IBAN` based on endpoint and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Company Name", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "Id of the organization", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumberVerificationResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/organizations/screening": { "get": { "tags": [ "Organizations" ], "summary": "Screening", "description": "AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.", "operationId": "OrganizationGlobal_Screening_GET", "parameters": [ { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax` and `external`, defaults to `organization` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated list of countries to include in the search - ISO 3166-1 format", "schema": { "maxLength": 50, "type": "string" } }, { "name": "id", "in": "query", "description": "Id of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } }, { "name": "listType", "in": "query", "description": "Comma-separated string of list types to screen against, defaults to all lists. Allowed values are `pep`, `sanction` and `adverseMedia`.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Used for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Set how many results you want per page (max/default 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screening.ScreeningResultDto" }, "example": { "offset": 0, "limit": 100, "size": 1, "links": { "next": null, "previous": null, "first": "http://api.signicat.com/information/organizations/screening?listType=pep%2csanction&name=OrgName&limit=100", "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": [], "media": [ { "title": null, "excerpt": null, "url": "https://google.com", "date": null } ], "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/organizations/search": { "get": { "tags": [ "Organizations" ], "summary": "Search - Beta", "description": "Search for an organization.\n \n Remarks when searching multiple sources:\n Functionality is subject to change without prior notice.", "operationId": "OrganizationGlobal_Search_GET", "parameters": [ { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `organization`, `tax` and `external`, defaults to `organization` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated list of countries to include in the search - ISO 3166-1 format", "schema": { "maxLength": 50, "type": "string" } }, { "name": "id", "in": "query", "description": "Id of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "description": "Cursor returned for paginating multiple sources, cannot be used together with `offset` and `limit`.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Used for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Set how many results you want per page (max/default 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization.SearchResultDto" }, "example": { "offset": 0, "limit": 100, "size": 1, "links": { "next": null, "previous": null, "first": "https://api.signicat.com/info/lookup/organizations/search?countries=no&name=signicat&cursor=eyJpi45...", "self": "https://api.signicat.com/info/lookup/organizations/search?countries=no&name=signicat&cursor=eyJpi45..." }, "data": [ { "organizationNumber": "989584022", "taxNumber": "832879", "externalId": "NO989584022", "name": "SIGNICAT AS", "links": { "self": "https://api.signicat.com/info/lookup/countries/NO/organizations/989584022" }, "country": { "name": null, "alpha2": "NO", "alpha3": "NOR", "numeric": "578" }, "address": { "street": "Bergen", "postalCode": "123", "city": "Bergen", "country": { "name": null, "alpha2": "NO", "alpha3": "NOR", "numeric": "578" } } } ], "metadata": { "sources": [ "no-brreg", "opencorporates" ], "urls": [], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/organizations/documents": { "get": { "tags": [ "Organizations" ], "summary": "Documents", "description": "Provides the link to download the documents(Registration, UBO map, Ownership map, Shareholders) from data registers.", "operationId": "OrganizationGlobal_Documents_GET", "parameters": [ { "name": "id", "in": "query", "description": "A unique identifier for the organization", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country where the organisation is located.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Optional filter for the organization name", "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "Specifies the type of document to retrieve", "schema": { "$ref": "#/components/schemas/DocumentType" } }, { "name": "deliveryMethod", "in": "query", "description": "Delivery method of the document", "schema": { "$ref": "#/components/schemas/DeliveryMethod" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/persons": { "get": { "tags": [ "Persons" ], "summary": "Basic", "description": "Retrieve basic info about a person", "operationId": "Person_GetBasic_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.BasicInfoDto" }, "example": { "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": [], "sourceSpecific": null, "metadata": { "sources": [ "no-infotorg-dsf" ], "urls": [], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/persons/address": { "get": { "tags": [ "Persons" ], "summary": "Address", "description": "Retrieve address info for a person. This endpoint is deprecated, use Basic instead.", "operationId": "Person_GetAddress_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.AddressInfoDto" }, "example": { "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": { "street": "Berlin", "postalCode": "1234", "city": "Berlin", "country": { "name": "Germany", "alpha2": "DE", "alpha3": "DEU", "numeric": "276" } }, "metadata": { "sources": [ "no-freg" ], "urls": [], "lastChanged": null, "rawJson": null, "isCache": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } }, "deprecated": true } }, "/countries/{country}/persons/finance": { "get": { "tags": [ "Persons" ], "summary": "Finance", "description": "Retrieve finance info for a person", "operationId": "Person_GetFinance_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.FinanceDto" }, "example": { "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/persons/contacts": { "get": { "tags": [ "Persons" ], "summary": "Contacts", "description": "Retrieve contacts for a person", "operationId": "Person_GetContacts_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.ContactsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/persons/identity/verify": { "get": { "tags": [ "Persons" ], "summary": "Identity Verification", "description": "Verification of a person identity", "operationId": "Person_VerifyAddress_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.AddressVerificationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/countries/{country}/persons/accountnumber/{accountNumber}/verify": { "get": { "tags": [ "Persons" ], "summary": "Account Holder Verification", "description": "Retrieve account details if a bank account is found (using an IBAN) and it matches the name provided.", "operationId": "Person_VerifyAccountNumber_GET", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 country code", "required": true, "schema": { "type": "string" } }, { "name": "accountNumber", "in": "path", "description": "Account number of the person", "required": true, "schema": { "type": "string" } }, { "name": "idType", "in": "query", "description": "Optional hint to what kind of id being used.\nAllowed values are `PersonalId`, `Passport`, `IdentityCard`, `DriversLicense`, `TravelDocument`, `ResidentPermit`, `TaxNumber` and `VoterId`, defaults to `PersonalId` and is only used by a limited number of sources.", "schema": { "type": "string" } }, { "name": "identityNumber", "in": "query", "description": "The national identity number used to identify the person", "schema": { "type": "string" } }, { "name": "givenName", "in": "query", "description": "The persons given name", "schema": { "type": "string" } }, { "name": "surname", "in": "query", "description": "The persons surname", "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "query", "description": "The persons date of birth", "schema": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, { "name": "caseRef", "in": "query", "description": "Case reference if required by the source", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "The persons street address", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "The persons street address number", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The persons postal code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The persons city place", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "The person's gender. Optional parameter.\nAllowed values are `Male`, `Female`, `Other`, `Unknown`. Defaults to `Unknown` and only applies to a limited number of data sources.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "PhoneNumber for the Identity verification", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumberVerificationResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/persons/search": { "get": { "tags": [ "Persons" ], "summary": "Search - Beta", "description": "Search for an person.\n Functionality is subject to change without prior notice.", "operationId": "PersonGlobal_Search_GET", "parameters": [ { "name": "dateOfBirth", "in": "query", "description": "Date of birth of the entity to search for, accepted formats: `yyyy-MM-dd`, `yyyy-MM` or `yyyy`", "schema": { "maxLength": 10, "type": "string" } }, { "name": "postalCode", "in": "query", "description": "Search person through postal code", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated list of countries to include in the search - ISO 3166-1 format", "schema": { "maxLength": 50, "type": "string" } }, { "name": "id", "in": "query", "description": "Id of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "description": "Used for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Set how many results you want per page (max/default 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person.SearchResultDto" }, "example": { "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/persons/screening": { "get": { "tags": [ "Persons" ], "summary": "Screening", "description": "AML/CFT screening against lists with politically exposed persons (PEP), sanctions and adverse media.", "operationId": "PersonGlobal_Screening_GET", "parameters": [ { "name": "dateOfBirth", "in": "query", "description": "Date of birth of the entity to search for, accepted formats: `yyyy-MM-dd`, `yyyy-MM` or `yyyy`", "schema": { "maxLength": 10, "type": "string" } }, { "name": "postalCode", "in": "query", "description": "Search person through postal code", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated list of countries to include in the search - ISO 3166-1 format", "schema": { "maxLength": 50, "type": "string" } }, { "name": "id", "in": "query", "description": "Id of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the entity to search for", "schema": { "maxLength": 100, "type": "string" } }, { "name": "source", "in": "query", "description": "Optional name of the source to use", "schema": { "maxLength": 50, "type": "string" } }, { "name": "rawJson", "in": "query", "description": "Optionally include the raw data received from the upstream if supported by the source", "schema": { "type": "boolean" } }, { "name": "listType", "in": "query", "description": "Comma-separated string of list types to screen against, defaults to all lists. Allowed values are `pep`, `sanction` and `adverseMedia`.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Used for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Set how many results you want per page (max/default 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screening.ScreeningResultDto" }, "example": { "offset": 0, "limit": 100, "size": 1, "links": { "next": null, "previous": null, "first": "http://api.signicat.com/information/organizations/screening?listType=pep%2csanction&name=OrgName&limit=100", "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": [], "media": [ { "title": null, "excerpt": null, "url": "https://google.com", "date": null } ], "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 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDto" }, "example": { "code": "PL-1900", "type": "https://developer.signicat.com/docs/data-verification/error-codes/#PL-1900", "title": "Error message", "detail": "This error is often an example", "status": null, "invalidParams": null } } } } } } }, "/sources/organization": { "get": { "tags": [ "Sources" ], "summary": "Organization", "description": "Returns the data sources available for organizations.", "operationId": "Source_GetOrganizationAvailability_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgLookupProvidersDto" }, "example": { "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" ] } } } } } } }, "/sources/person": { "get": { "tags": [ "Sources" ], "summary": "Natural person", "description": "Returns the data sources available for natural persons.", "operationId": "Source_GetPersonAvailability_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonLookupProvidersDto" }, "example": { "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" ] } } } } } } }, "/sources/accountsandattributes": { "get": { "tags": [ "Sources" ], "summary": "Accounts and Attributes", "description": "Returns the data sources available for Accounts and Attributes.", "operationId": "Source_GetAccountsAndAttributesAvailability_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountsAndAttributesLookupProvidersDto" } } } } } } } }, "components": { "schemas": { "AccountDetailsDto": { "type": "object", "properties": { "accountType": { "$ref": "#/components/schemas/AccountType" }, "accountStatus": { "$ref": "#/components/schemas/AccountStatus" }, "isJoinedAccount": { "type": "boolean", "description": "If the account is shared", "nullable": true }, "numberOfHolders": { "type": "integer", "description": "The number of account holders", "format": "int32", "nullable": true }, "foreign": { "type": "boolean", "description": "If the account is foreign", "nullable": true }, "countryOfAccount": { "$ref": "#/components/schemas/Iso3166Dto" } }, "additionalProperties": false, "description": "Account Type" }, "AccountNumberVerificationResultDto": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account Number", "nullable": true }, "isValidAccountNumber": { "type": "boolean", "description": "If the Account Number is valid", "nullable": true }, "validationDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationDetailsDto" }, "description": "Client details", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "accountDetails": { "$ref": "#/components/schemas/AccountDetailsDto" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false, "description": "Iban validation" }, "AccountStatus": { "enum": [ "unknown", "active", "inactive", "renumbered" ], "type": "string" }, "AccountType": { "enum": [ "unknown", "person", "organization" ], "type": "string" }, "AccountsAndAttributes.DomainInfo": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Domain", "nullable": true }, "createdDate": { "type": "string", "description": "Creation Date of the Domain", "format": "date-time", "nullable": true }, "isDisposable": { "type": "boolean", "description": "Indicates whether the Domain is disposable" } }, "additionalProperties": false }, "AccountsAndAttributes.EmailInfo": { "type": "object", "properties": { "valid": { "type": "boolean", "description": "Indicates whether the email is valid." }, "riskScore": { "type": "number", "description": "A numerical score representing the risk associated with the email.", "format": "double" }, "isDeliverable": { "type": "boolean", "description": "Indicates if the mail can be delivered to the mail id provided." }, "age": { "type": "number", "description": "Indicates the age of the email in months", "format": "double" }, "domain": { "$ref": "#/components/schemas/AccountsAndAttributes.DomainInfo" }, "remarks": { "type": "array", "items": { "type": "string" }, "description": "Additional notes or comments about the Email.", "nullable": true } }, "additionalProperties": false }, "AccountsAndAttributes.FraudRiskDto": { "type": "object", "properties": { "email": { "$ref": "#/components/schemas/AccountsAndAttributes.EmailInfo" }, "phoneNumber": { "$ref": "#/components/schemas/AccountsAndAttributes.PhoneNumberInfo" }, "ipAddress": { "$ref": "#/components/schemas/AccountsAndAttributes.IpAddressInfo" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "AccountsAndAttributes.GeoLocation": { "type": "object", "properties": { "country": { "type": "string", "description": "The country associated with the IP address.", "nullable": true }, "region": { "type": "string", "description": "The region or state associated with the IP address.", "nullable": true }, "city": { "type": "string", "description": "The city associated with the IP address.", "nullable": true } }, "additionalProperties": false }, "AccountsAndAttributes.IpAddressInfo": { "type": "object", "properties": { "isRisky": { "type": "boolean", "description": "Indicates whether the IP address is considered risky." }, "riskScore": { "type": "number", "description": "A numerical score representing the risk associated with the IP address.", "format": "double" }, "lastSeenDays": { "type": "integer", "description": "The number of days since the IP address was last seen.", "format": "int32", "nullable": true }, "vpn": { "type": "boolean", "description": "Indicates if the IP is using vpn service." }, "geoLocation": { "$ref": "#/components/schemas/AccountsAndAttributes.GeoLocation" }, "remarks": { "type": "array", "items": { "type": "string" }, "description": "Additional notes or comments about the IP address.", "nullable": true } }, "additionalProperties": false }, "AccountsAndAttributes.PhoneNumberInfo": { "type": "object", "properties": { "valid": { "type": "boolean", "description": "Indicates whether the phone number is valid." }, "riskScore": { "type": "number", "description": "A numerical score representing the risk associated with the phone number.", "format": "double" }, "isDisposable": { "type": "boolean", "description": "Indicates whether the phone number is disposable (e.g., temporary)." }, "type": { "$ref": "#/components/schemas/AccountsAndAttributes.PhoneNumberType" }, "carrier": { "type": "string", "description": "The carrier or service provider associated with the phone number.", "nullable": true }, "country": { "type": "string", "description": "The country code associated with the phone number.", "nullable": true }, "remarks": { "type": "array", "items": { "type": "string" }, "description": "Additional notes or comments about the Phone Info.", "nullable": true } }, "additionalProperties": false }, "AccountsAndAttributes.PhoneNumberType": { "enum": [ "mobile", "voip", "landline", "tollfree", "premium", "voicemail", "prepaid", "payphone", "pager", "invalid", "unknown" ], "type": "string" }, "AccountsAndAttributesLookupProvidersDto": { "type": "object", "properties": { "providers": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SourceInfoDto" }, "nullable": true }, "description": "Contains information about providers that provide AccountsAndAttributes data sources", "nullable": true }, "profiles": { "type": "array", "items": { "type": "string" }, "description": "Contains the different profiles for AccountsAndAttributes data sources", "nullable": true } }, "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "street": { "type": "string", "description": "Street address or PO box", "nullable": true }, "postalCode": { "type": "string", "description": "Zip code / Postal code", "nullable": true }, "city": { "type": "string", "description": "City or place", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" } }, "additionalProperties": false, "description": "Address of the entity" }, "AddressTypeDto": { "enum": [ "unknown", "registered", "business", "postal" ], "type": "string" }, "ApproximateBirthDto": { "type": "object", "properties": { "monthOfBirth": { "type": "string", "description": "Month of birth", "nullable": true }, "yearOfBirth": { "type": "string", "description": "Year of birth", "nullable": true }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "isApproximate": { "type": "boolean" } }, "additionalProperties": false }, "AssociateDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the associate", "nullable": true }, "association": { "type": "string", "description": "Type of association", "nullable": true }, "comments": { "type": "string", "description": "Additional information / Detailed description", "nullable": true } }, "additionalProperties": false }, "BirthDto": { "type": "object", "properties": { "monthOfBirth": { "type": "string", "description": "Month of birth", "nullable": true }, "yearOfBirth": { "type": "string", "description": "Year of birth", "nullable": true }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" } }, "additionalProperties": false, "description": "Birth information" }, "BusinessRegistry.RegistrationAuthorityDto": { "type": "object", "properties": { "authorityCode": { "type": "string", "description": "Authority code", "nullable": true }, "countryCode": { "type": "string", "description": "ISO 3166-1 country codes", "nullable": true }, "country": { "type": "string", "description": "Country name", "nullable": true }, "localizedName": { "type": "string", "description": "Localized name", "nullable": true }, "internationalName": { "type": "string", "description": "International name", "nullable": true }, "jurisdiction": { "type": "string", "description": "Jurisdiction", "nullable": true }, "responsibleOrgLocalizedName": { "type": "string", "description": "Localized name of the responsible organization", "nullable": true }, "responsibleOrgInternationalName": { "type": "string", "description": "Name of the responsible organization", "nullable": true }, "website": { "type": "string", "description": "Website", "nullable": true } }, "additionalProperties": false }, "BusinessRegistry.RegistrationAuthorityItemDto": { "type": "object", "properties": { "authorityCode": { "type": "string", "description": "Authority code", "nullable": true }, "countryCode": { "type": "string", "description": "ISO 3166-1 country codes", "nullable": true }, "country": { "type": "string", "description": "Country name", "nullable": true }, "localizedName": { "type": "string", "description": "Localized name", "nullable": true }, "internationalName": { "type": "string", "description": "International name", "nullable": true }, "jurisdiction": { "type": "string", "description": "Jurisdiction", "nullable": true }, "self_url": { "type": "string", "description": "Link to more information", "nullable": true } }, "additionalProperties": false }, "CitizenshipDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Is active" }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "startDate": { "type": "string", "description": "Start Date", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End Date", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DeliveryDto": { "type": "object", "properties": { "contentType": { "type": "string", "description": "pdf, video, zip etc", "nullable": true }, "url": { "type": "string", "description": "Url for download the file", "nullable": true }, "method": { "type": "string", "description": "Delivery method: \"url\", \"base64\", or \"zip_url\".", "nullable": true }, "content": { "type": "string", "description": "Base64-encoded content (used when method is \"base64\").", "nullable": true } }, "additionalProperties": false }, "DeliveryMethod": { "enum": [ "base64" ], "type": "string" }, "DocumentDto": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Name of the file including extension.", "nullable": true }, "type": { "type": "string", "description": "Type of the document (used for classification or filtering).", "nullable": true }, "delivery": { "$ref": "#/components/schemas/DeliveryDto" } }, "additionalProperties": false }, "DocumentResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique number associated with organisation or document.", "nullable": true }, "name": { "type": "string", "description": "Legal name of the organization.", "nullable": true }, "document": { "$ref": "#/components/schemas/DocumentDto" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "DocumentType": { "enum": [ "basic", "shareholder", "registration", "financial", "tax", "ownership", "ubo", "board", "historical", "registerExtract", "other", "groupStructure" ], "type": "string" }, "EntityTypeDto": { "enum": [ "unknown", "organization", "person" ], "type": "string" }, "ExtendedAddressDto": { "type": "object", "properties": { "street": { "type": "string", "description": "Street address or PO box", "nullable": true }, "postalCode": { "type": "string", "description": "Zip code / Postal code", "nullable": true }, "city": { "type": "string", "description": "City or place", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "type": { "$ref": "#/components/schemas/AddressTypeDto" }, "startDate": { "type": "string", "description": "Start date of the address", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date of the address", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "If the address is active based on the start and end date", "readOnly": true } }, "additionalProperties": false }, "FunctionDto": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Start date", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true }, "function": { "type": "string", "description": "Type of function", "nullable": true } }, "additionalProperties": false }, "GenderDto": { "enum": [ "unknown", "female", "male", "other" ], "type": "string", "description": "Gender of the person (Only for entityType \"person\")" }, "Geo.DivisionListItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Geodata.CountryInfoDto": { "type": "object", "properties": { "self_url": { "type": "string", "nullable": true }, "subdivisions_url": { "type": "string", "nullable": true }, "continent": { "type": "string", "nullable": true }, "capital": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "population": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "isoAlpha3": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "continentName": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "isoNumeric": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Geodata.CountryListItemDto": { "type": "object", "properties": { "self_url": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "isoAlpha3": { "type": "string", "nullable": true }, "isoNumeric": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdNumberDto": { "type": "object", "properties": { "idNumber": { "type": "string", "description": "The identity number", "nullable": true }, "type": { "$ref": "#/components/schemas/IdNumberTypeDto" }, "country": { "$ref": "#/components/schemas/Iso3166Dto" } }, "additionalProperties": false, "description": "Identity number" }, "IdNumberTypeDto": { "enum": [ "unknown", "nationalIdentityNumber", "socialSecurityNumber", "taxIdentificationNumber", "identificationDocumentNumber" ], "type": "string", "description": "The type of the identity number" }, "IdentityStatusDto": { "enum": [ "notIdentified", "identified", "partiallyIdentified" ], "type": "string" }, "InvalidParamDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of attribute that was invalid", "nullable": true }, "reason": { "type": "string", "description": "A human-readable explanation specific to this field", "nullable": true } }, "additionalProperties": false }, "Iso3166Dto": { "type": "object", "properties": { "name": { "type": "string", "description": "Country name", "nullable": true }, "alpha2": { "type": "string", "description": "Two digit country code", "nullable": true }, "alpha3": { "type": "string", "description": "Three digit country code", "nullable": true }, "numeric": { "type": "string", "description": "Numeric country code", "nullable": true } }, "additionalProperties": false, "description": "ISO 3166-1 country codes" }, "LinkDto": { "type": "object", "properties": { "self": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Links to the item" }, "ListTypeDto": { "enum": [ "unknown", "pep", "sanction", "adverseMedia" ], "type": "string" }, "MatchCertaintyDto": { "enum": [ "unknown", "high", "medium", "low" ], "type": "string" }, "MatchStrengthDto": { "type": "object", "properties": { "score": { "type": "integer", "description": "A score from 0 - 100 where higher values are more relevant", "format": "int32", "nullable": true }, "certainty": { "$ref": "#/components/schemas/MatchCertaintyDto" } }, "additionalProperties": false, "description": "An indication of how relevant the result is" }, "MatchType": { "enum": [ "unknown", "name", "id" ], "type": "string" }, "MediaLinkDto": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the content", "nullable": true }, "excerpt": { "type": "string", "description": "An excerpt of the content", "nullable": true }, "url": { "type": "string", "description": "Url to the content", "nullable": true }, "date": { "type": "string", "description": "Date of the content", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MetadataDto": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "string" }, "description": "List of sources for the data", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Public urls to the sources", "nullable": true }, "lastChanged": { "type": "string", "description": "The date the data was last changed", "format": "date-time", "nullable": true }, "rawJson": { "type": "string", "description": "The raw JSON if it was requested and supported by the source", "nullable": true }, "isCache": { "type": "boolean", "description": "Return boolean whether data is retrieved from cache." } }, "additionalProperties": false, "description": "Metadata about the response" }, "NameDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/NameStatus" }, "full": { "type": "string", "description": "Full name of the entity", "nullable": true }, "first": { "type": "string", "description": "First/given name of the entity", "nullable": true }, "last": { "type": "string", "description": "Last/surname of the entity", "nullable": true }, "middle": { "type": "string", "description": "Middle name of the entity", "nullable": true } }, "additionalProperties": false, "description": "Name of the entity" }, "NameStatus": { "enum": [ "partial", "all" ], "type": "string", "description": "A hint to which attributes are set.\n`partial` : only full name,\n`all` : all attributes." }, "NamedValueDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NationalityDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Is active" }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Nationality of an entity" }, "OrgLookupProvidersDto": { "type": "object", "properties": { "providers": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SourceInfoDto" }, "nullable": true }, "description": "Contains information about providers that provide organizational data sources", "nullable": true }, "profiles": { "type": "array", "items": { "type": "string" }, "description": "Contains the different profiles for organizational data sources", "nullable": true } }, "additionalProperties": false }, "Organization.AuthorizationDto": { "type": "object", "properties": { "signature": { "$ref": "#/components/schemas/Organization.SignatureDto" }, "powerOfProcuration": { "$ref": "#/components/schemas/Organization.PowerOfProcurationDto" }, "metadata": { "$ref": "#/components/schemas/OrganizationMetadataDto" } }, "additionalProperties": false }, "Organization.AuthorizationRole": { "enum": [ "unknown", "ceo", "boardLeader", "boardMember", "procuration", "signature", "bookkeeper", "accountant", "houseManager", "ceoSubstitute", "viceBoardLeader", "deputyBoardMember", "partner", "alternateMember", "foreign", "auditor", "legalRepresentative", "owner", "publicEntity", "representative", "taxRepresentative", "shareholder", "legalEntity" ], "type": "string", "description": "Role of the entity" }, "Organization.AuthorizationStatus": { "enum": [ "unknown", "error", "none", "incomplete", "complete" ], "type": "string", "description": "Describes the authorization response. Meaning of each status:\n\n- \"unknown\": unknown value\n- \"error\": no combinations could be generated\n- \"none\": no combinations available\n- \"incomplete\": the response contains combinations, but there may be more\n- \"complete\": the response contains all possible combinations" }, "Organization.BasicInfoDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Organization name", "nullable": true }, "names": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.OrganizationNameDto" }, "description": "List of organization names", "nullable": true }, "organizationNumber": { "type": "string", "description": "The organization number", "nullable": true }, "vatNumber": { "type": "string", "description": "VAT number of the organization", "nullable": true }, "registrationDate": { "type": "string", "description": "Registration date of the organization", "format": "date-time", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "businessAddress": { "$ref": "#/components/schemas/AddressDto" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedAddressDto" }, "description": "Addresses", "nullable": true }, "organizationType": { "$ref": "#/components/schemas/Organization.OrganizationTypeDto" }, "legalStatus": { "$ref": "#/components/schemas/Organization.LegalStatus" }, "employees": { "type": "integer", "description": "Number of employees", "format": "int32", "nullable": true }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.IndustryDto" }, "description": "A list of industries the organization is involved in according to the NACE Rev. 2 classification;", "nullable": true }, "contact": { "$ref": "#/components/schemas/Organization.ContactInfoDto" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.BasisSignerDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/NameDto" }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "role": { "$ref": "#/components/schemas/Organization.SignerRole" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.SignerRole" }, "description": "List of Roles associated to the Basis Signer", "nullable": true }, "identityNumber": { "$ref": "#/components/schemas/IdNumberDto" } }, "additionalProperties": false }, "Organization.CombinationBasis": { "type": "object", "properties": { "people": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.BasisSignerDto" }, "description": "The people", "nullable": true } }, "additionalProperties": false, "description": "Contains the data that was used to form the basis for the combinations" }, "Organization.CompanyRoleDto": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Organization.Role" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.RoleWithDateDto" }, "description": "Roles of the entity", "nullable": true }, "name": { "type": "string", "description": "Name of the company", "nullable": true }, "organizationNumber": { "$ref": "#/components/schemas/OrganizationNumberDto" } }, "additionalProperties": false }, "Organization.ContactInfoDto": { "type": "object", "properties": { "phone": { "$ref": "#/components/schemas/PhoneNumberDto" }, "email": { "type": "string", "description": "Email address", "nullable": true } }, "additionalProperties": false, "description": "Contact information for the organization" }, "Organization.CreditRatingDto": { "type": "object", "properties": { "score": { "type": "string", "description": "Credit rating score", "nullable": true }, "ratingSystem": { "type": "string", "description": "Name of the rating system used", "nullable": true }, "description": { "type": "string", "description": "A description of the code", "nullable": true }, "link": { "type": "string", "description": "Link to the rating used if available", "nullable": true }, "year": { "type": "integer", "description": "Year of the score", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Credit score information" }, "Organization.FinanceDto": { "type": "object", "properties": { "creditRating": { "$ref": "#/components/schemas/Organization.CreditRatingDto" }, "numberOfPaymentRemarks": { "type": "integer", "description": "Number of payment remarks registered on the organization", "format": "int32", "nullable": true }, "profitAndLoss": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.ProfitAndLossDto" }, "description": "Account figures", "nullable": true }, "netWorth": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.NetWorthDto" }, "description": "Key figures", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.IndirectOwnershipRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Direct and indirect ownership range" }, "Organization.IndustryDto": { "type": "object", "properties": { "code": { "type": "string", "description": "NACE Rev. 2 code", "nullable": true }, "description": { "type": "string", "description": "NACE Rev. 2 description", "nullable": true }, "section": { "type": "string", "description": "NACE Rev. 2 section (A-U) the code belongs to", "nullable": true }, "level": { "type": "integer", "description": "Hierarchical level of the code", "format": "int32" } }, "additionalProperties": false, "description": "NACE Rev. 2 classification" }, "Organization.IntegratedOwnershipRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Direct and indirect ownership range" }, "Organization.IntegratedRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Shareholders integrated percentage range" }, "Organization.LegalStatus": { "enum": [ "unknown", "active", "inactive", "insolvent", "terminating", "terminated", "deleted" ], "type": "string" }, "Organization.NetWorthDto": { "type": "object", "properties": { "year": { "type": "integer", "description": "Fiscal year", "format": "int32", "nullable": true }, "currency": { "type": "string", "description": "ISO 4217 currency code", "nullable": true }, "value": { "type": "integer", "description": "Value of the organization", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Organization.OrganizationNameDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "nullable": true }, "type": { "$ref": "#/components/schemas/Organization.OrganizationNameType" }, "start": { "type": "string", "description": "Start date of the name", "format": "date-time", "nullable": true }, "end": { "type": "string", "description": "End date of the name", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Organization.OrganizationNameType": { "enum": [ "unknown", "tradeName", "registered" ], "type": "string" }, "Organization.OrganizationTypeDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the organization type", "nullable": true }, "code": { "type": "string", "description": "Code representation of the organization type", "nullable": true }, "url": { "type": "string", "description": "Url containing different codes", "nullable": true } }, "additionalProperties": false, "description": "Organization type" }, "Organization.OtherRoleDto": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Organization.Role" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.RoleWithDateDto" }, "description": "Roles of the entity", "nullable": true }, "name": { "type": "string", "description": "Name of the entity", "nullable": true }, "id": { "type": "string", "description": "Id of the entity", "nullable": true } }, "additionalProperties": false }, "Organization.OtherShareholderDto": { "type": "object", "properties": { "percentage": { "type": "number", "description": "Shareholding percentage in the organization", "format": "double", "nullable": true }, "percentageRange": { "$ref": "#/components/schemas/Organization.PercentageRangeDto" }, "votingRights": { "type": "number", "description": "Shareholders Voting rights percentage", "format": "double", "nullable": true }, "votingRightsRange": { "$ref": "#/components/schemas/Organization.VotingRightsRangeDto" }, "integratedOwnership": { "type": "number", "description": "Integrated shareholding percentage in the organization", "format": "double", "nullable": true }, "integratedOwnershipRange": { "$ref": "#/components/schemas/Organization.IntegratedRangeDto" }, "sourceSpecific": { "type": "object", "description": "Source-specific supplementary data that is not part of the normalised schema. Contains additional fields unique to the originating data provider, or null if no source-specific data is available.", "nullable": true }, "name": { "type": "string", "description": "Name of the entity", "nullable": true }, "id": { "type": "string", "description": "Id of the entity", "nullable": true } }, "additionalProperties": false }, "Organization.OwnershipDto": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.ShareholderCompanyDto" }, "description": "List of shareholding companies", "nullable": true }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.ShareholderPersonDto" }, "description": "List of shareholding persons", "nullable": true }, "otherShareholders": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.OtherShareholderDto" }, "description": "List of shareholders who's type is not known", "nullable": true }, "sourceSpecific": { "type": "object", "description": "Source-specific supplementary data that is not part of the normalised schema. Contains additional fields unique to the originating data provider, or null if no source-specific data is available.", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.OwnershipRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Shareholding percentage range" }, "Organization.PercentageRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Shareholding percentage range" }, "Organization.PersonRoleDto": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Organization.Role" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.RoleWithDateDto" }, "description": "Roles of the entity", "nullable": true }, "name": { "$ref": "#/components/schemas/NameDto" }, "address": { "$ref": "#/components/schemas/AddressDto" }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "nationality": { "$ref": "#/components/schemas/Iso3166Dto" }, "identityNumber": { "$ref": "#/components/schemas/IdNumberDto" } }, "additionalProperties": false }, "Organization.PowerOfProcurationDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Organization.AuthorizationStatus" }, "description": { "type": "string", "description": "Description", "nullable": true }, "combinations": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.SignerCombinations" }, "description": "List of signature combinations", "nullable": true }, "basis": { "$ref": "#/components/schemas/Organization.CombinationBasis" }, "metadata": { "$ref": "#/components/schemas/Organization.SignatureMetadataDto" } }, "additionalProperties": false, "description": "People with authorization to sign and to act on behalf of the business in some matters." }, "Organization.ProfitAndLossDto": { "type": "object", "properties": { "year": { "type": "integer", "description": "Fiscal year", "format": "int32", "nullable": true }, "currency": { "type": "string", "description": "ISO 4217 currency code", "nullable": true }, "turnover": { "type": "integer", "description": "Gross revenue", "format": "int64", "nullable": true }, "grossProfit": { "type": "integer", "description": "Revenue after deducting the cost of goods", "format": "int64", "nullable": true }, "netProfit": { "type": "integer", "description": "Revenue after deducting operating, interest, and tax expenses", "format": "int64", "nullable": true }, "netProfitAfterTax": { "type": "integer", "description": "Revenue after deducting tax expenses", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Organization.Role": { "enum": [ "unknown", "ceo", "boardLeader", "boardMember", "procuration", "signature", "bookkeeper", "accountant", "partner", "alternateMember", "auditor", "representative", "foreign", "legalEntity", "shareholder", "owner", "legalRepresentative", "taxRepresentative", "publicEntity", "houseManager", "ceoSubstitute", "viceBoardLeader", "deputyBoardMember" ], "type": "string", "description": "Role of the entity" }, "Organization.RoleWithDateDto": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Organization.Role" }, "startDate": { "type": "string", "description": "Start date of the role", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date of the role", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "Description of the role", "nullable": true } }, "additionalProperties": false }, "Organization.RolesDto": { "type": "object", "properties": { "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.PersonRoleDto" }, "description": "A list of persons with roles", "nullable": true }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.CompanyRoleDto" }, "description": "A list of companies with roles", "nullable": true }, "others": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.OtherRoleDto" }, "description": "Entities who's type is not known", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.SearchItemDto": { "type": "object", "properties": { "organizationNumber": { "type": "string", "description": "Organization number", "nullable": true }, "taxNumber": { "type": "string", "description": "Tax number of the entity (can be: TAX number, VAT number or Tax Identification Number (TIN))", "nullable": true }, "externalId": { "type": "string", "description": "External Id of the entity (internal source id)", "nullable": true }, "name": { "type": "string", "description": "Name of the entity", "nullable": true }, "links": { "$ref": "#/components/schemas/LinkDto" }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "address": { "$ref": "#/components/schemas/AddressDto" } }, "additionalProperties": false }, "Organization.SearchResultDto": { "type": "object", "properties": { "offset": { "type": "integer", "description": "The offset of the current page.", "format": "int32" }, "limit": { "type": "integer", "description": "The limit of the current paging options.", "format": "int32" }, "size": { "type": "integer", "description": "The total size of the collection (irrespective of any paging options).", "format": "int64" }, "links": { "$ref": "#/components/schemas/PageLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.SearchItemDto" }, "description": "The result data", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.ShareholderCompanyDto": { "type": "object", "properties": { "percentage": { "type": "number", "description": "Shareholding percentage in the organization", "format": "double", "nullable": true }, "percentageRange": { "$ref": "#/components/schemas/Organization.PercentageRangeDto" }, "votingRights": { "type": "number", "description": "Shareholders Voting rights percentage", "format": "double", "nullable": true }, "votingRightsRange": { "$ref": "#/components/schemas/Organization.VotingRightsRangeDto" }, "integratedOwnership": { "type": "number", "description": "Integrated shareholding percentage in the organization", "format": "double", "nullable": true }, "integratedOwnershipRange": { "$ref": "#/components/schemas/Organization.IntegratedRangeDto" }, "sourceSpecific": { "type": "object", "description": "Source-specific supplementary data that is not part of the normalised schema. Contains additional fields unique to the originating data provider, or null if no source-specific data is available.", "nullable": true }, "name": { "type": "string", "description": "Name of the company", "nullable": true }, "organizationNumber": { "$ref": "#/components/schemas/OrganizationNumberDto" } }, "additionalProperties": false }, "Organization.ShareholderPersonDto": { "type": "object", "properties": { "percentage": { "type": "number", "description": "Shareholding percentage in the organization", "format": "double", "nullable": true }, "percentageRange": { "$ref": "#/components/schemas/Organization.PercentageRangeDto" }, "votingRights": { "type": "number", "description": "Shareholders Voting rights percentage", "format": "double", "nullable": true }, "votingRightsRange": { "$ref": "#/components/schemas/Organization.VotingRightsRangeDto" }, "integratedOwnership": { "type": "number", "description": "Integrated shareholding percentage in the organization", "format": "double", "nullable": true }, "integratedOwnershipRange": { "$ref": "#/components/schemas/Organization.IntegratedRangeDto" }, "sourceSpecific": { "type": "object", "description": "Source-specific supplementary data that is not part of the normalised schema. Contains additional fields unique to the originating data provider, or null if no source-specific data is available.", "nullable": true }, "name": { "$ref": "#/components/schemas/NameDto" }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true } }, "additionalProperties": false }, "Organization.SignatureDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Organization.AuthorizationStatus" }, "description": { "type": "string", "description": "Description", "nullable": true }, "combinations": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.SignerCombinations" }, "description": "List of signature combinations", "nullable": true }, "basis": { "$ref": "#/components/schemas/Organization.CombinationBasis" }, "metadata": { "$ref": "#/components/schemas/Organization.SignatureMetadataDto" } }, "additionalProperties": false, "description": "People with authorization to sign and to act on behalf of the business in all matters." }, "Organization.SignatureMetadataDto": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "string" }, "description": "List of sources for the data", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Public urls to the sources", "nullable": true }, "lastChanged": { "type": "string", "description": "The date the data was last changed", "format": "date-time", "nullable": true }, "rawJson": { "type": "string", "description": "The raw JSON if it was requested and supported by the source", "nullable": true } }, "additionalProperties": false, "description": "Metadata about the response" }, "Organization.SignerCombinations": { "type": "object", "properties": { "signers": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.SignerDto" }, "description": "The signers in a combination", "nullable": true }, "description": { "type": "string", "description": "A description", "nullable": true } }, "additionalProperties": false }, "Organization.SignerDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/NameDto" }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "role": { "$ref": "#/components/schemas/Organization.SignerRole" }, "identityNumber": { "$ref": "#/components/schemas/IdNumberDto" } }, "additionalProperties": false }, "Organization.SignerRole": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/Organization.AuthorizationRole" }, "description": { "type": "string", "description": "Text description of the role", "nullable": true } }, "additionalProperties": false, "description": "Role of the signer" }, "Organization.UboDto": { "type": "object", "properties": { "ultimateBeneficiaryOwners": { "type": "array", "items": { "$ref": "#/components/schemas/Organization.UltimateBeneficiaryOwnerDto" }, "description": "Ultimate beneficiary owners", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Organization.UboOwnershipDto": { "type": "object", "properties": { "directOwnership": { "type": "number", "description": "Shareholding percentage", "format": "double", "nullable": true }, "directOwnershipRange": { "$ref": "#/components/schemas/Organization.OwnershipRangeDto" }, "indirectOwnership": { "type": "number", "description": "Indirect ownership", "format": "double", "nullable": true }, "indirectOwnershipRange": { "$ref": "#/components/schemas/Organization.IndirectOwnershipRangeDto" }, "integratedOwnership": { "type": "number", "description": "Direct and indirect ownership", "format": "double", "nullable": true }, "integratedOwnershipRange": { "$ref": "#/components/schemas/Organization.IntegratedOwnershipRangeDto" }, "votingRights": { "type": "number", "description": "Voting rights of the person in percent", "format": "double", "nullable": true }, "votingRightsRange": { "$ref": "#/components/schemas/Organization.VotingRightsRangeDto" }, "votingPower": { "type": "number", "description": "Voting power in percent. The voting power may reflect the ability to influence the voting outcome or the extent of control over the company (the exact formula used to calculate this value may be different depending on the source).", "format": "double", "nullable": true }, "votingPowerRange": { "$ref": "#/components/schemas/Organization.VotingPowerRangeDto" } }, "additionalProperties": false, "description": "Ownership information" }, "Organization.UboRoleDto": { "enum": [ "unknown", "boardMember", "shareholder", "other" ], "type": "string", "description": "Role of the person" }, "Organization.UltimateBeneficiaryOwnerDto": { "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/Organization.UboOwnershipDto" }, "name": { "$ref": "#/components/schemas/NameDto" }, "address": { "$ref": "#/components/schemas/AddressDto" }, "birth": { "$ref": "#/components/schemas/BirthDto" }, "gender": { "$ref": "#/components/schemas/GenderDto" }, "identityNumber": { "$ref": "#/components/schemas/IdNumberDto" }, "nationality": { "$ref": "#/components/schemas/Iso3166Dto" }, "role": { "$ref": "#/components/schemas/Organization.UboRoleDto" } }, "additionalProperties": false }, "Organization.VotingPowerRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Voting power percentage range" }, "Organization.VotingRightsRangeDto": { "type": "object", "properties": { "from": { "type": "number", "description": "Greater than or equal to", "format": "double", "nullable": true }, "to": { "type": "number", "description": "Less than or equal to", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Shareholders voting rights percentage range" }, "OrganizationMetadataDto": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "string" }, "description": "List of sources for the data", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Public urls to the sources", "nullable": true }, "lastChanged": { "type": "string", "description": "The date the data was last changed", "format": "date-time", "nullable": true }, "rawJson": { "type": "string", "description": "The raw JSON if it was requested and supported by the source", "nullable": true }, "isCache": { "type": "boolean", "description": "Return boolean whether data is retrieved from cache." }, "accountingYear": { "type": "integer", "description": "Accounting year of the data", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Metadata about the response" }, "OrganizationNumberDto": { "type": "object", "properties": { "domestic": { "type": "string", "description": "The domestic organization number", "nullable": true }, "dunsNumber": { "type": "string", "description": "Data Universal Numbering System (DUNS number) for the organization. https://en.wikipedia.org/wiki/Data_Universal_Numbering_System", "nullable": true }, "legalEntityIdentifier": { "type": "string", "description": "Legal Entity Identifier (LEI) - global identifier of legal entities participating in financial transactions. https://en.wikipedia.org/wiki/Legal_Entity_Identifier", "nullable": true } }, "additionalProperties": false, "description": "Organization numbers in different formats" }, "PageLinks": { "type": "object", "properties": { "self": { "type": "string", "nullable": true }, "next": { "type": "string", "description": "Url of the next page", "nullable": true }, "previous": { "type": "string", "description": "Url of the previous page", "nullable": true }, "first": { "type": "string", "description": "Url of the first page", "nullable": true } }, "additionalProperties": false, "description": "Links for paging" }, "Person.AddressInfoDto": { "type": "object", "properties": { "permanent": { "$ref": "#/components/schemas/AddressDto" }, "postal": { "$ref": "#/components/schemas/AddressDto" }, "foreign": { "$ref": "#/components/schemas/AddressDto" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Person.AddressVerificationDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/IdentityStatusDto" }, "description": { "type": "string", "description": "Identity description", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Person.BasicInfoDto": { "type": "object", "properties": { "names": { "type": "array", "items": { "$ref": "#/components/schemas/Person.PersonNameDto" }, "description": "Names", "nullable": true }, "birth": { "$ref": "#/components/schemas/Person.PersonBirthDto" }, "death": { "$ref": "#/components/schemas/Person.PersonDeathDto" }, "nationalities": { "type": "array", "items": { "$ref": "#/components/schemas/NationalityDto" }, "description": "Nationalities", "nullable": true }, "citizenships": { "type": "array", "items": { "$ref": "#/components/schemas/CitizenshipDto" }, "description": "Citizenship's", "nullable": true }, "permanentAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Person.PersonAddressDto" }, "description": "Permanent addresses", "nullable": true }, "postalAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Person.PersonAddressDto" }, "description": "Postal address", "nullable": true }, "foreignAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Person.PersonAddressDto" }, "description": "Foreign address", "nullable": true }, "sourceSpecific": { "type": "object", "description": "Source Specific fields", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Person.ContactDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "preferredLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Person.ContactsDto": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Person.ContactDto" }, "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Person.CreditScoreDto": { "type": "object", "properties": { "score": { "type": "string", "description": "Credit score value", "nullable": true }, "scoringSystem": { "type": "string", "description": "Name of the scoring system used", "nullable": true }, "link": { "type": "string", "description": "Link to the scoring used if available", "nullable": true }, "year": { "type": "integer", "description": "Year of the score", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Credit score information" }, "Person.FinanceDto": { "type": "object", "properties": { "creditScore": { "$ref": "#/components/schemas/Person.CreditScoreDto" }, "numberOfPaymentRemarks": { "type": "integer", "description": "Number of payment remarks registered on the individual", "format": "int32", "nullable": true }, "incomeAndWealth": { "type": "array", "items": { "$ref": "#/components/schemas/Person.FinanceInfoDto" }, "description": "Financial information", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Person.FinanceInfoDto": { "type": "object", "properties": { "year": { "type": "integer", "description": "Year the info is from", "format": "int32", "nullable": true }, "currency": { "type": "string", "description": "ISO 4217 currency code", "nullable": true }, "grossIncome": { "type": "integer", "description": "Income before deductions", "format": "int64", "nullable": true }, "netIncome": { "type": "integer", "description": "Income after deductions", "format": "int64", "nullable": true }, "wealth": { "type": "integer", "description": "Value of everything owned by the individual", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Person.PersonAddressDto": { "type": "object", "properties": { "street": { "type": "string", "description": "Street address or PO box", "nullable": true }, "postalCode": { "type": "string", "description": "Zip code / Postal code", "nullable": true }, "city": { "type": "string", "description": "City or place", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "isActive": { "type": "boolean", "description": "If the address is active" }, "isConfidential": { "type": "boolean", "description": "If the address is confidential" }, "startDate": { "type": "string", "description": "Start date of the address", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date of the address", "format": "date-time", "nullable": true }, "addressLines": { "type": "array", "items": { "type": "string" }, "description": "Address lines if the source contains unstructured data", "nullable": true } }, "additionalProperties": false, "description": "Address information" }, "Person.PersonBirthDto": { "type": "object", "properties": { "monthOfBirth": { "type": "string", "description": "Month of birth", "nullable": true }, "yearOfBirth": { "type": "string", "description": "Year of birth", "nullable": true }, "dateOfBirth": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "country": { "$ref": "#/components/schemas/Iso3166Dto" }, "location": { "type": "string", "description": "Birth location", "nullable": true } }, "additionalProperties": false }, "Person.PersonDeathDto": { "type": "object", "properties": { "monthOfDeath": { "type": "string", "description": "Month of death", "nullable": true }, "yearOfDeath": { "type": "string", "description": "Year of death", "nullable": true }, "dateOfDeath": { "type": "string", "format": "yyyy-MM-dd", "nullable": true }, "isDead": { "type": "boolean", "description": "If the person is dead or not" } }, "additionalProperties": false }, "Person.PersonNameDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/NameStatus" }, "full": { "type": "string", "description": "Full name of the entity", "nullable": true }, "first": { "type": "string", "description": "First/given name of the entity", "nullable": true }, "last": { "type": "string", "description": "Last/surname of the entity", "nullable": true }, "middle": { "type": "string", "description": "Middle name of the entity", "nullable": true }, "isActive": { "type": "boolean", "description": "If the name is active" }, "startDate": { "type": "string", "description": "Start date of the name", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date of the name", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Person.SearchItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the entity", "nullable": true }, "name": { "$ref": "#/components/schemas/NameDto" }, "country": { "$ref": "#/components/schemas/Iso3166Dto" } }, "additionalProperties": false }, "Person.SearchResultDto": { "type": "object", "properties": { "offset": { "type": "integer", "description": "The offset of the current page.", "format": "int32" }, "limit": { "type": "integer", "description": "The limit of the current paging options.", "format": "int32" }, "size": { "type": "integer", "description": "The total size of the collection (irrespective of any paging options).", "format": "int64" }, "links": { "$ref": "#/components/schemas/PageLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person.SearchItemDto" }, "description": "The result data", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "PersonLookupProvidersDto": { "type": "object", "properties": { "providers": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SourceInfoDto" }, "nullable": true }, "description": "Contains information about providers that provide person data sources", "nullable": true }, "profiles": { "type": "array", "items": { "type": "string" }, "description": "Contains the different profiles for person data sources", "nullable": true } }, "additionalProperties": false }, "PhoneNumberDto": { "type": "object", "properties": { "nationalNumber": { "type": "string", "description": "The national number", "nullable": true }, "countryCode": { "type": "integer", "description": "Country dial code if the national number was recognized as valid", "format": "int32", "nullable": true }, "intlFormat": { "type": "string", "description": "The number formatted according to its locale if the national number was recognized as valid", "nullable": true } }, "additionalProperties": false, "description": "Phone number" }, "ProblemDto": { "type": "object", "properties": { "code": { "type": "string", "description": "A code that identifies the type of error that occured", "nullable": true }, "type": { "type": "string", "description": "A URI reference that identifies the problem type", "nullable": true }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type", "nullable": true }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem", "nullable": true }, "status": { "type": "integer", "description": "The HTTP status code", "format": "int32", "nullable": true }, "invalidParams": { "type": "array", "items": { "$ref": "#/components/schemas/InvalidParamDto" }, "description": "A list of parameters that are invalid", "nullable": true } }, "additionalProperties": false }, "Screening.ScreenedItemDto": { "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityTypeDto" }, "listType": { "$ref": "#/components/schemas/ListTypeDto" }, "matchStrength": { "$ref": "#/components/schemas/MatchStrengthDto" }, "sourceName": { "type": "string", "description": "Name of the source the item was found in", "nullable": true }, "name": { "$ref": "#/components/schemas/NameDto" }, "gender": { "$ref": "#/components/schemas/GenderDto" }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/NameDto" }, "description": "Aliases for the item", "nullable": true }, "associates": { "type": "array", "items": { "$ref": "#/components/schemas/AssociateDto" }, "description": "Associates of the item (Only for entityType \"person\")", "nullable": true }, "datesOfBirth": { "type": "array", "items": { "$ref": "#/components/schemas/ApproximateBirthDto" }, "description": "Possible dates of birth (Only for entityType \"person\")", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" }, "description": "Addresses of the entity", "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValueDto" }, "description": "Comments", "nullable": true }, "functions": { "type": "array", "items": { "$ref": "#/components/schemas/FunctionDto" }, "description": "Functions", "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MediaLinkDto" }, "description": "Online content related to the item (Only for entityType \"person\")", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Screening.ScreeningRolesDto" }, "description": "Person screening roles associated", "nullable": true } }, "additionalProperties": false }, "Screening.ScreeningResultDto": { "type": "object", "properties": { "offset": { "type": "integer", "description": "The offset of the current page.", "format": "int32" }, "limit": { "type": "integer", "description": "The limit of the current paging options.", "format": "int32" }, "size": { "type": "integer", "description": "The total size of the collection (irrespective of any paging options).", "format": "int64" }, "links": { "$ref": "#/components/schemas/PageLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Screening.ScreenedItemDto" }, "description": "The result data", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "additionalProperties": false }, "Screening.ScreeningRolesDto": { "type": "object", "properties": { "roleType": { "type": "string", "description": "Screening type of role", "nullable": true }, "organization": { "type": "string", "description": "Screening organization", "nullable": true }, "description": { "type": "string", "description": "Screening description", "nullable": true }, "startDate": { "type": "string", "description": "Screening role start date", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Screening role end date", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SourceInfoDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the source", "nullable": true }, "profiles": { "type": "array", "items": { "type": "string" }, "description": "The profiles supported by the source", "nullable": true }, "name": { "type": "string", "description": "Name of the source", "nullable": true }, "officialName": { "type": "string", "description": "Official name of the source", "nullable": true }, "description": { "type": "string", "description": "Description of the source", "nullable": true } }, "additionalProperties": false, "description": "Contains information about a source" }, "ValidationDetailsDto": { "type": "object", "properties": { "isMatching": { "type": "boolean", "description": "If matches", "nullable": true }, "matchType": { "$ref": "#/components/schemas/MatchType" }, "description": { "type": "string", "description": "Validation description", "nullable": true } }, "additionalProperties": false, "description": "Validation details" } } } }