API Objects
Identifiers
Some objects have unique identifiers in the Bits platform. These identifiers are called Bits Resource Names, or BRNs for
short. A BRN is made up of the bits prefix, followed by a colon and object prefix, another colon and an optional
subcategory prefix, and finally a UUID. For example, all customers have a CustomerID on the form
bits:customer::<UUID>.
The most common identifiers are:
| Object | Prefix | Example |
|---|---|---|
| Customer | bits:customer: | bits:customer::123e4567-e89b-12d3-a456-426614174000 |
| User | bits:user: | bits:user::123e4567-e89b-12d3-a456-426614174000 |
| Application | bits:application: | bits:application::123e4567-e89b-12d3-a456-426614174000 |
| Market | bits:market: | bits:market::123e4567-e89b-12d3-a456-426614174000 |
| Workflow | bits:workflow: | bits:workflow::123e4567-e89b-12d3-a456-426614174000 |
| Organization | bits:organization: | bits:organization::123e4567-e89b-12d3-a456-426614174000 |
| Individual | bits:individual: | bits:individual::123e4567-e89b-12d3-a456-426614174000 |
Times and Dates
Dates are sent as ISO 8601 strings, for example 2022-01-01. Dates never include time information. Timestamps are
ISO 8601 strings including time information, for example 2022-01-01T12:00:00Z.
Percentage Intervals
| Property | Type | Description |
|---|---|---|
exclusiveFrom | number | The lower bound of the interval |
inclusiveTo | number | The upper bound of the interval |
Entities
Individuals
Personal Identity Numbers
| Property | Type | Description |
|---|---|---|
id | string | The personal identity number |
issuingCountry | ISO3166Alpha2 | The country that issued the personal identity number |
Legal Genders
| LegalGender | Description |
|---|---|
| Male | Male |
| Female | Female |
| Unknown | Unknown |
Organizations
Organization Identifiers
| Property | Type | Description |
|---|---|---|
id | string | The organization identifier |
issuingCountry | ISO3166Alpha2 | The country that issued the organization identifier |
Legal Forms
Sweden
Click to see list of Swedish legal forms
| LegalForm | Description |
|---|---|
SE_PRIVAT_AKTIEBOLAG | Swedish private limited company |
SE_PUBLIKT_AKTIEBOLAG | Swedish public limited company |
SE_PRIVAT_SKADEFORSAKRINGSBOLAG | Swedish private insurance company |
SE_SKADEFORSAKRINGSBOLAG | Swedish insurance company |
SE_LIVFORSAKRINGSBOLAG | Swedish life insurance company |
SE_PUBLIKT_BANKAKTIEBOLAG | Swedish public bank |
SE_PRIVAT_BANKAKTIEBOLAG | Swedish private bank |
SE_PUBLIKT_LIVFORSAKRINGSBOLAG | Swedish public life insurance company |
SE_PRIVAT_LIVFORSAKRINGSBOLAG | Swedish private life insurance company |
SE_PUBLIKT_SKADEFORSAKRINGSBOLAG | Swedish public insurance company |
SE_AKTIEBOLAG | Swedish limited company |
SE_BANKAKTIEBOLAG | Swedish bank |
SE_BOSTADSFORENING | Swedish housing association |
SE_UTLANDSK_BANKS_FILIAL | Swedish branch of a foreign bank |
SE_BOSTADSRATTSFORENING | Swedish tenant-owner association |
SE_ENSKILD_FIRMA | Swedish sole proprietorship |
SE_EUROPEISK_EKONOMISK_INTRESSEGRUPPERING | Swedish European Economic Interest Grouping |
SE_EUROPEISKA_GRUPPERINGAR_FOR_TERRITORIELLT_SAMARBETE | Swedish European Groupings for Territorial Cooperation |
SE_EKONOMISK_FORENING | Swedish economic association |
SE_FORSAKRINGSAKTIEBOLAG | Swedish insurance company |
SE_FILIAL_TILL_UTLANDSKT_BOLAG | Swedish branch of a foreign company |
SE_FORSAKRINGSFORENING | Swedish insurance association |
SE_HANDELSBOLAG | Swedish trading partnership |
SE_IDEELL_FORENING | Swedish non-profit association |
SE_ENKELT_BOLAG | Swedish simple partnership |
SE_PARTREDERI | Swedish partnership |
SE_VARDEPAPPERSFOND | Swedish securities fund |
SE_HANDELSBOLAG_KOMMANDITBOLAG | Swedish trading partnership limited partnership |
SE_FORSAKRINGSBOLAG | Swedish insurance company |
SE_EUROPABOLAG | Swedish European company |
SE_KOOPERATIV_HYRESRATTSFORENING | Swedish cooperative housing association |
SE_EUROPAKOOPERATIV | Swedish European cooperative |
SE_SAMFALLIGHET | Swedish community |
SE_REGISTRERAT_TROSSAMFUND | Swedish registered religious community |
SE_FAMILJESTIFTELSE | Swedish family foundation |
SE_STIFTELSE_FOND | Swedish foundation fund |
SE_STATLIG_ENHET | Swedish state entity |
SE_KOMMUN | Swedish municipality |
SE_KOMMUNFORBUND | Swedish municipal federation |
SE_LANDSTING | Swedish county council |
SE_ALLMAN_FORSAKRINGSKASSA | Swedish public insurance fund |
SE_ENHET_INOM_SVENSKA_KYRKAN | Swedish church entity |
SE_OFFENTLIG_KORPORATION_OCH_ANSTALT | Swedish public corporation and institution |
SE_HYPOTEKSFORENING | Swedish mortgage association |
SE_REGIONAL_STATLIG_MYNDIGHET | Swedish regional state authority |
SE_OSKIFTAT_DODSBO | Swedish undivided estate |
SE_SPARBANK | Swedish savings bank |
SE_UNDERSTODSFORENING | Swedish support association |
SE_ERKAND_ARBETSLOSHETSKASSA | Swedish recognized unemployment fund |
SE_UTLANDSK_JURIDISK_PERSON | Swedish foreign legal entity |
SE_OVRIG_SVENSK_JURIDISK_PERSON | Swedish other legal entity |
SE_OKAND_JURIDISK_FORM | Swedish unknown legal form |
SE_KOMMANDITBOLAG | Swedish limited partnership |
SE_KOOPERATIV_HYRESGASTFORENING | Swedish cooperative tenant association |
SE_MEDLEMSBANK | Swedish member bank |
SE_OMSESIDIGT_FORSAKRINGSBOLAG | Swedish mutual insurance company |
SE_OMSESIDIGT_TJANSTEPENSIONSBOLAG | Swedish mutual service pension company |
SE_STIFTELSE | Swedish foundation |
SE_SAMBRUKSFORENING | Swedish joint use association |
SE_TJANSTEPENSIONSAKTIEBOLAG | Swedish service pension company |
SE_TJANSTEPENSIONSFORENING | Swedish service pension association |
United Kingdom
Click to see list of British legal forms
| LegalForm | Description |
|---|---|
GB_PRIVATE_UNLIMITED_COMPANY | Private unlimited company |
GB_PRIVATE_LIMITED_COMPANY | Private limited company |
GB_PUBLIC_LIMITED_COMPANY | Public limited company |
GB_OLD_PUBLIC_COMPANY | Old public company |
GB_PRIVATE_LIMITED_COMPANY_GUARANTEE_WITHOUT_SHARE_CAPITAL_USE_OF_LTD_EXEMPTION | Private Limited Company by guarantee without share capital use of 'Limited' exemption |
GB_LIMITED_PARTNERSHIP | Limited partnership |
GB_PRIVATE_LIMITED_COMPANY_GUARANTEE_WITHOUT_SHARE_CAPITAL | Private limited company guarantee without share capital |
GB_CONVERTED_OR_CLOSED | Converted/closed company |
GB_PRIVATE_UNLIMITED_COMPANY_WITHOUT_SHARE_CAPITAL | Private unlimited company without share capital |
GB_PRIVATE_LIMITED_COMPANY_USE_OF_LTD_EXEMPTION | Private limited company use of 'Limited' exemption |
GB_PROTECTED_CELL_COMPANY | Protected cell company |
GB_EUROPEAN_ECONOMIC_INTEREST_GROUPING_ESTABLISHMENT | European Economic Interest Grouping Establishment (EEIG) |
GB_INVESTMENT_COMPANY_WITH_VARIABLE_CAPITAL | Investment company with variable capital |
GB_INVESTMENT_COMPANY_WITH_VARIABLE_CAPITAL_SECURITIES | Investment company with variable capital securities |
GB_INVESTMENT_COMPANY_WITH_VARIABLE_CAPITAL_WARRANT | Investment company with variable capital warrant |
GB_INVESTMENT_COMPANY_WITH_VARIABLE_CAPITAL_UMBRELLA | Investment company with variable capital umbrella |
GB_REGISTERED_SOCIETY_NON_JURISDICTIONAL | Registered society |
GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY | Industrial and provident society |
GB_NORTHERN_IRELAND_COMPANY | Northern Ireland company |
GB_NORTHERN_IRELAND_COMPANY_CREDIT_UNION | Credit union (Northern Ireland) |
GB_OTHER | Other |
GB_EUROPEAN_PUBLIC_LIMITED_LIABILITY_COMPANY | European public limited liability company (SE) |
GB_SOCIETAS | United Kingdom Societas |
GB_EUROPEAN_ECONOMIC_INTEREST_GROUPING | European Economic Interest Grouping |
GB_ECONOMIC_INTEREST_GROUPING | UK Economic Interest Grouping |
GB_ASSURANCE_COMPANY | Assurance company |
GB_CHARITABLE_INCORPORATED_ORGANIZATION | Charitable incorporated organization |
GB_FURTHER_EDUCATION_OR_SIXTH_FORM_COLLEGE_CORPORATION | Further education or sixth form college corporation |
GB_LIMITED_LIABILITY_PARTNERSHIP | Limited liability partnership |
GB_OVERSEAS_COMPANY | Overseas company |
GB_OVERSEAS_ENTITY | Overseas entity |
GB_ROYAL_CHARTER_COMPANY | Royal charter company |
GB_SCOTTISH_CHARITABLE_INCORPORATED_ORGANIZATION | Scottish charitable incorporated organization |
GB_SCOTTISH_QUALIFYING_PARTNERSHIP | Scottish qualifying partnership |
GB_UK_ESTABLISHMENT_COMPANY | UK establishment company |
GB_UNREGISTERED_COMPANY | Unregistered company |
Ireland
Click to see list of Irish legal forms
| LegalForm | Description |
|---|---|
IE_LTD_BY_SHARES | Limited by shares |
IE_PUBLIC_LIMITED_COMPANY | Public limited company |
IE_PUBLIC_LIMITED_COMPANY_CLOSED_ENDED | Public limited company (closed ended) |
IE_PUBLIC_LIMITED_COMPANY_VARIABLE_SHARE_CAPITAL | Public limited company variable share capital |
IE_PRIVATE_LIMITED_BY_SHARES_LICENSE_TO_OMIT_LTD | Private limited by shares, license to omit ltd |
IE_PRIVATE_COMPANY_WITH_VARIABLE_SHARE_CAPITAL | Private company with variable share capital |
IE_PRIVATE_COMPANY_GUARANTEE_WITH_SHARE_CAPITAL | Private guarantee with share capital |
IE_PRIVATE_LIMITED_BY_SHARES | Private limited by shares |
IE_PRIVATE_UNLIMITED_WITH_SHARE_CAPITAL | Private unlimited with share capital |
IE_PUBLIC_UNLIMITED_COMPANY_WITH_SHARE_CAPITAL | Public unlimited company with share capital |
IE_SINGLE_MEMBER_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_WITH_SHARE_CAPITAL | Single member private company limited by guarantee with share capital |
IE_SINGLE_MEMBER_PRIVATE_COMPANY_LIMITED_BY_SHARES | Single member private company limited by shares |
IE_UCIT | U.C.I.T |
IE_PART_X11_PUBLIC_PRIVATE_INVESTMENT_COMPANY | Part X11 public/private investment company |
IE_FOREIGN_BODY_CORPORATE_MAKING_LOCAL_OFFER | Foreign body corporate making local offer (B18a) |
IE_LIMITED_PARTNERSHIP | Limited partnership |
IE_PRIVATE_GUARANTEE_WITH_SHARES_LICENSE_TO_OMIT_LTD | Private guarantee with shares, license to omit ltd |
IE_SE_NEW_INCORPORATION | Societas Europaea - New Incorporation |
IE_SE_TRANSFER_INTO_STATE | Societas Europaea - Transfer into State |
IE_SE_FORMATION_OF_SUBSIDIARY | Societas Europaea - Formation of Subsidiary |
IE_INWARD_MIGRATING_COMPANY | Inward migrating company |
IE_SE_PLC_CONVERSION | Societas Europaea - PLC conversion |
IE_PLC_SE_CONVERSION | PLC - Societas Europaea conversion |
IE_ULC | ULC - Private Unlimited Company |
IE_IC | IC - Investment company - Part 24 Companies Act 2014 |
IE_UCITS | UCITS - Undertaking for Collective Investment in Transferable Securities |
IE_DAC_LIMITED_BY_GUARANTEE_LICENSED | DAC limited by guarantee licensed |
IE_PUC_LICENSED | PUC - Public Unlimited Company (licenced company) |
IE_PUC_WITHOUT_SHARE_CAPITAL_LICENSED | PUC without share capital licensed |
IE_ULC_LICENSED | ULC - Private Unlimited Company (licenced company) |
IE_PUC | PUC -Public Unlimited Company |
IE_PLC | PLC - Public Limited Company |
IE_PULC_WITHOUT_SHARE_CAPITAL | PULC - Public Unlimited Company without share capital (licenced company) |
IE_PUC_WITHOUT_SHARE_CAPITAL | PUC without share capital |
IE_CLG | CLG - Company Limited by Guarantee |
IE_CLG_LICENSED | CLG - Company Limited by Guarantee (licensed company) |
IE_DAC | DAC - Designated Activity Company |
IE_DAC_LIMITED_BY_SHARES_LICENSED | DAC - Designated Activity Company (limited by shares) (licensed company) |
IE_DAC_LIMITED_BY_GUARANTEE | DAC - Designated Activity Company (limited by guarantee) |
IE_PUBLIC_GUARANTEE_WITHOUT_SHARE_CAPITAL | Guarantee company without a share capital (public) |
IE_PUBLIC_LICENSE_GUARANTEE_WITHOUT_SHARE_CAPITAL | Guarantee licence company w/o sh/capital (public) |
IE_RESERVED_NAME | Reserved name |
IE_EXTERNAL_COMPANY | External company |
Organization Statuses
Organization statuses are prefixed by country where the status is applicable. Detailed enumerated list of values coming soon.
Industry Codes
Industry codes are prefixed by country where the code is applicable. Detailed enumerated list of values coming soon.
Registration Authorities
| Registration Authority | Description |
|---|---|
UNKNOWN | Unknown |
COMPANIES_HOUSE | Companies House UK |
CRO | Companies Registration Office Ireland |
KVK | Chamber of Commerce Netherlands |
ASIC | Australian Securities and Investments Commission |
RCS | Registre du Commerce et des Sociétés France |
INFOGREFFE | Infogreffe France |
KBO | Kruispuntbank van Ondernemingen Belgium |
CVR | Central Business Register Denmark |
BOLAGSVERKET | Bolagsverket Sweden |
PRH | Patentti- ja rekisterihallitus Finland |
BRONNOYSUND | Brønnøysundregistrene Norway |
Note on German registration authorities
In Germany, a company is registered with a district court. These are the possible registration authorities in Germany:
Click to see list of German district courts
- LEIPZIG
- FRANKFURT_AM_MAIN
- BAD_HERSFELD
- STENDAL
- LEMGO
- KORBACH
- HAGEN
- NEUBRANDENBURG
- HILDESHEIM
- COTTBUS
- BOCHUM
- INGOLSTADT
- FRIEDBERG
- HOF
- KIEL
- LUEBECK
- FLENSBURG
- KEMPTEN
- AACHEN
- POTSDAM
- DUESSELDORF
- WUERZBURG
- ANSBACH
- ROSTOCK
- JENA
- CHEMNITZ
- KLEVE
- ULM
- KOELN
- ASCHAFFENBURG
- BRAUNSCHWEIG
- WALSRODE
- COBURG
- WETZLAR
- FRANKFURT_ODER
- KREFELD
- PINNEBERG
- SCHWERIN
- MAINZ
- BAYREUTH
- DEGGENDORF
- TRAUNSTEIN
- BAD_OEYNHAUSEN
- NEURUPPIN
- PADERBORN
- HAMM
- HANNOVER
- SIEGEN
- SIEGBURG
- LANDSHUT
- GIESSEN
- MUENCHEN
- STRAUBING
- WUPPERTAL
- BAMBERG
- BAD_HOMBURG
- GELSENKIRCHEN
- AUGSBURG
- KOENIGSTEIN
- DARMSTADT
- SAARBRUECKEN
- CHARLOTTENBURG_BERLIN
- ALTENBURG
- AMBERG
- APOLDA
- ARNSBERG
- ARNSTADT
- ARNSTADT_ZWEIGSTELLE_ILMENAU
- AURICH
- BAD_HOMBURG_VDH
- BAD_KREUZNACH
- BAD_SALZUNGEN
- BERLIN_CHARLOTTENBURG
- BIELEFELD
- BONN
- BREMEN
- COESFELD
- DORTMUND
- DRESDEN
- DUISBURG
- DUEREN
- EISENACH
- ERFURT
- ESCHWEGE
- ESSEN
- FREIBURG
- FRITZLAR
- FULDA
- FUERTH
- GERA
- GOTHA
- GOETTINGEN
- GREIZ
- GUETERSLOH
- HAMBURG
- HANAU
- HEILBAD_HEILIGENSTADT
- HILDBURGHAUSEN
- HOMBURG
- ISERLOHN
- KAISERSLAUTERN
- KASSEL
- KEMPTEN_ALLGAEU
- KOBLENZ
- LANDAU
- LANGENFELD
- LEBACH
- LIMBURG
- LUDWIGSHAFEN_A_RHEIN_LUDWIGSHAFEN
- LUENEBURG
- MANNHEIM
- MARBURG
- MEININGEN
- MEMMINGEN
- MERZIG
- MOENCHENGLADBACH
- MONTABAUR
- MUEHLHAUSEN
- MUENSTER
- NEUNKIRCHEN
- NEUSS
- NORDHAUSEN
- NUERNBERG
- OFFENBACH_AM_MAIN
- OLDENBURG
- OSNABRUECK
- OTTWEILER
- PASSAU
- POESSNECK
- POESSNECK_ZWEIGSTELLE_BAD_LOBENSTEIN
- RECKLINGHAUSEN
- REGENSBURG
- RUDOLSTADT
- SAARLOUIS
- SCHWEINFURT
- SOEMMERDA
- SONDERSHAUSEN
- SONNEBERG
- STADTHAGEN
- STADTRODA
- STEINFURT
- ST_INGBERT
- STRALSUND
- STUTTGART
- ST_WENDEL
- SUHL
- TOSTEDT
- VOELKLINGEN
- WEIDEN_I_D_OPF
- WEIMAR
- WIESBADEN
- WITTLICH
- ZWEIBRUECKEN
Governing Members
Person Governing Member
| Property | Type | Description |
|---|---|---|
type | PERSON | Type of entity |
name | string | Name of the person |
dateOfBirth | Optional<Date> | Date of birth of the person |
citizenship | Optional<ISO3166Alpha2> | Citizenship of the person |
countryOfResidence | Optional<ISO3166Alpha2> | Country of residence of the person |
roles | Array<GoverningMemberRole> | Roles of the person at the organization |
personalIdentityNumber | Optional<PersonalIdentityNumber> | Personal identity number of the person |
pepHits | Array<PepHit> | PEP hits for the person |
sanctionHits | Array<PersonSanctionHit> | Sanction hits for the person |
Organization Governing Member
| Property | Type | Description |
|---|---|---|
type | ORGANIZATION | Type of entity |
name | string | Name of the organization |
roles | Array<GoverningMemberRole> | Roles of the organization at the organization |
organizationNumber | string | Organization identifier of the organization |
sanctionHits | Array<OrganizationSanctionHit> | Sanction hits for the organization |
Governing Member Roles
| Property | Type | Description |
|---|---|---|
roleName | string | The name of the role |
fromDate | Optional<Date> | The date the role started |
Beneficial Owners
Beneficial Owner
| Property | Type | Description |
|---|---|---|
fullName | string | Full name of the beneficial owner |
personalIdentityNumber | Optional<PersonalIdentityNumber> | Personal identity number of the owner |
dateOfBirth | Optional<Date> | Date of birth of the beneficial owner |
extentOfControl | Optional<ExtentOfControl> | Extent of control of the beneficial owner |
extentOfOwnership | number | Extent of ownership of the beneficial owner |
residence | ISO3166Alpha2 | Country of residence of the beneficial owner |
citizenship | ISO3166Alpha2 | Citizenship of the beneficial owner |
registrationDate | Optional<Date> | Date of registration of the beneficial owner |
pepHits | Array<PepHit> | PEP hits for the beneficial owner |
sanctionHits | Array<PersonSanctionHit> | Sanction hits for the beneficial owner |
controlDetails | Array<ControlDetails> | Details of the control of the beneficial owner |
Extent of Control
| Property | Type | Description |
|---|---|---|
exactValue | Optional<number> | The exact extent of control |
intervalValue | Optional<PercentageInterval> | The interval of the extent of control |
Control Details
| Property | Type | Description |
|---|---|---|
controlType | direct|through-organization | The type of control |
organization | Optional<ControlOrganization> | The organization that the control is through |
Control Organization
| Property | Type | Description |
|---|---|---|
name | string | Name of the organization |
organizationIdentifiers | OrganizationIdentifiers | Organization identifiers of the organization |
registrationDate | Optional<Date> | Date of registration of the organization |
sanctionHits | Array<OrganizationSanctionHit> | Sanction hits for the organization |
Signatory Authorities
Person Signatory Authority
| Property | Type | Description |
|---|---|---|
type | PERSON | Type of entity |
name | string | Name of the person |
roles | Array<string> | Roles of the person at the organization |
dateOfBirth | Date | Date of birth of the person |
personalIdentityNumber | Optional<PersonalIdentityNumber> | Personal identity number of the person |
hasAdminRights | boolean | Does the person have admin rights at the organization |
Organization Signatory Authority
| Property | Type | Description |
|---|---|---|
type | ORGANIZATION | Type of entity |
name | string | Name of the organization |
roles | Array<string> | Roles of the organization at the organization |
organizationNumber | OrganizationNumber | Organization identifier of the organization |
Signed By
The signing entity is always a PERSON.
| Property | Type | Description |
|---|---|---|
name | string | Name of the person |
personalIdentityNumber | Optional<PersonalIdentityNumber> | Personal identity number of the person |
pepHits | Array<PersonSanctionHit> | PEP hits for the person |
sanctionHits | Array<PersonSanctionHit> | Sanction hits for the person |
Applications
Application Status
| Status | Description |
|---|---|
NOT_STARTED | The application has not been started yet |
IN_PROGRESS | The application is in progress |
COMPLETED | The application has been completed |
DECLINED | The application has been declined |
CANCELLED | The application has been cancelled |
APPROVED | The application has been approved |
FAILED | The application has failed |
MANUAL_REVIEW | The application is under manual review |
MANUALLY_APPROVED | The application has been manually approved |
MANUALLY_DECLINED | The application has been manually declined |
Application object
| Property | Type | Description |
|---|---|---|
applicationId | ApplicationID | The application ID |
status | ApplicationStatus | The status of the application |
customerId | CustomerID | The customer ID |
workflowId | WorkflowID | The workflow ID |
marketId | MarketID | The market ID |
createdAt | Timestamp | The creation time |
updatedAt | Timestamp | The last update time |
Addresses
AddressType
| AddressType | Description |
|---|---|
| "VISITING" | Visiting address |
| "BILLING" | Billing address |
| "SHIPPING" | Shipping address |
| "RESIDENTIAL" | Residential address |
| "POSTAL" | Postal address |
| "DELIVERY" | Delivery address |
| "OFFICE" | Office address |
| "INVOICE" | Invoice address |
| "REGISTERED" | Registered address |
| "SERVICE" | Service address |
| "OTHER" | Unknown address type |
Address object
| Property | Type | Description |
|---|---|---|
addressType | AddressType | The type of address |
addressLine1 | string | Address line 1 |
addressLine2 | Optional<string> | Address line 2 |
postalCode | string | Postal code |
city | string | City |
region | Optional<string> | Region |
country | ISO3166Alpha2 | Country |
PEP and Sanction hits
Source
| Property | Type | Description |
|---|---|---|
name | string | The name of the source |
link | string | A link to the source |
Pep hits
| Property | Type | Description |
|---|---|---|
name | string | The name of the person |
personalIdentityNumber | Optional<PersonalIdentityNumber> | The personal identity number of the person |
dateOfBirth | Optional<Date> | The date of birth of the person |
gender | LegalGender | The gender of the person |
pepCountry | ISO3166Alpha2 | The country where the person is a PEP |
roles | Array<PepRole> | The roles of the person as a PEP |
source | Source | The source of the PEP information |
Pep roles
| Property | Type | Description |
|---|---|---|
active | boolean | Is the role currently active |
category | string | The category of the role |
detailedCategory | string | A more detailed category of the role |
description | string | A description of the role |
fromDate | Optional<Timestamp> | The date the role started |
toDate | Optional<Timestamp> | The date the role ended |
Sanction hits
Person sanction hits
| Property | Type | Description |
|---|---|---|
name | string | Name of the person |
akas | Array<string> | Known aliases of the person |
gender | LegalGender | Legal gender of the person |
dateOfBirths | Array<Date> | List of distinct date of births registered at the source |
citizenships | ISO3166Alpha2 | Citizenships of the person |
legalBasis | string | Legal basis for the sanction hit |
source | Source | Source of the sanction hit |
listedDate | Date | Date of the sanction hit |
Organization sanction hits`
| Property | Type | Description |
|---|---|---|
name | string | Name of the organization |
aliases | Array<string> | Known aliases of the organization |
connectedCountries | Array<ISO3166Alpha2> | Countries connected to the organization |
website | string | Website of the organization |
address | Address | Address of the organization |
source | Source | Source of the sanction hit |
listedDate | Date | Date of the sanction hit |
Bank Accounts
IBAN
| Property | Type | Description |
|---|---|---|
type | IBAN | The type of bank account |
iban | string | The IBAN of the bank account |
bic | Optional<string> | The BIC of the bank account |
Swedish Domestic Bank Accounts
| Property | Type | Description |
|---|---|---|
type | SWEDEN_DOMESTIC | The type of bank account |
clearingNumber | string | The clearing number of the bank account |
accountNumber | string | The account number of the bank account |
Documents
Document object
| Property | Type | Description |
|---|---|---|
id | string | Identifier for the document. |
name | string | The name of the document. |
type | DocumentType | The type of the document. |
context | DocumentContext | The context of the document. |
contentType | MIME-type | The content type of the document. |
size | number | The size of the document in bytes. |
createdAt | Timestamp | The date and time the document was uploaded. |
downloadUrl | string | The URL to download the document. |
uploadedBy | Actor | The entity that uploaded the document. |
DocumentType
Identification Documents
| DocumentType | Description |
|---|---|
PASSPORT | Passport |
NATIONAL_ID | ID card |
DRIVERS_LICENSE | Driver's license |
RESIDENCE_PERMIT | Residence permit |
VISA | Visa |
Organization Documents
| DocumentType | Description |
|---|---|
ACCOUNT_VERIFICATION | Account verification |
ARTICLES_OF_ASSOCIATION | Articles of association |
BANK_STATEMENT | Bank statement |
BUSINESS_LICENSE_OR_REGISTRATION | Business license or registration |
BUSINESS_PLAN | Business plan |
CERTIFICATE_OF_INCORPORATION | Certificate of incorporation |
CORPORATE_STRUCTURE | Corporate structure |
FINANCIAL_STATEMENTS | Financial statements |
PROOF_OF_REGULATORY_LICENSE_OR_REGISTRATION | Proof of regulatory license or registration |
SOURCE_OF_FUNDS_AND_WEALTH | Source of funds and wealth |
SHAREHOLDING_INFORMATION | Shareholding information |
TAX_IDENTIFICATION_NUMBER | Tax identification number |
Individual Documents
| DocumentType | Description |
|---|---|
PROOF_OF_ADDRESS | Proof of address |
PROOF_OF_IDENTITY | Proof of identity |
BIRTH_CERTIFICATE | Birth certificate |
Other Documents
| DocumentType | Description |
|---|---|
SIGNATURE | Signature |
PROOF_OF_TRANSACTION | Proof of transaction |
OTHER | Other |