Shared data types
The API uses custom data types which are not present in standard graphql:
Simple types
Timestamp
A UNIX timestamp version of a date and time. The value is in milliseconds.
Chunks
Json representation of a Chunk:
{
"id": "12345678",
"payload": "35633766",
"payloadSize": 8,
"mimeType": "text/plain",
"subType": "ExternalId/DK/CVR/Number",
"acceptance": "accepted",
"timeCreated": 12345678,
"timeLastEdited": 12345678
}
Chunks are a generic type that most data in the API is based on, they all contain a type, and a subtype and the value is stored in the payload field. The payloads may be a file, for such cases the mimetype is included in the output.
The chunks have an acceptance value that indicates the acceptance status of a particular chunk.
Possible values for acceptance
-field
accepted
rejected
pending
expired
For information on reading chunks from Companies and Persons, check under their section in the menu.
The payload will either be plaintext or base64 encoded depending on the MimeType
ExternalId_DK_CPR_Number
The CPR number in Denmark of a person
ExternalId_DK_CVR_Number
The VAT number in Denmark of the company
ExternalId_DK_CVR_APIId
The ApiId in the Danish VAT registry of the company or person
ExternalId_Vendor_Economic_CustomerNumber
An identifier in Economic for this a company or person
ContactInfo_Email
The contact email of a company or person
ContactInfo_Phone
The contact phonenumber of a company or person
IdentityValidationToken_DKNemIDCPR
An identity validation token from the danish NemID system.
Document
A document that has either been user-defined or defined by the system, could be a passport or a driving license.
ListCheck
A record of when we checked various PEP and sanctions lists for the name of the company or person.
Info Types
Info types describe a person or company that may or may not already exist in our database.
PersonInfo
You only need to supply one of these, but you should add all the info you can.
Field | Description |
---|---|
Name | The name of the person |
ExternalId_DK_CVR_APIId | The ApiId in the Danish VAT registry of the person, can be several |
ExternalId_DK_CPR_Number | The CPR number in Denmark of a person |
ContactInfo_Email | The contact email of the person, can be several |
ContactInfo_Phone | The contact phonenumber of the person, can be several |
ExternalId_GenericCustomerNumber | An identifier in your own system for this person, can be several |
ExternalId_Vendor_Economic_CustomerNumber | An identifier in your Economic system for this person, can be several |
All fields in info, except Name, accepts multiple values.
Json representation of PersonInfo. You only need to supply one of the following pieces of information:
{
"Name": "FirstName Lastname",
"ExternalId_DK_CVR_APIId": ["XXXXXX"],
"ExternalId_DK_CPR_Number": ["XXXXXXXX"],
"ContactInfo_Email": ["XXXXXX"],
"ContactInfo_Phone": ["XXXXXX"],
"ExternalId_GenericCustomerNumber": ["XXXXXX"],
"ExternalId_Vendor_Economic_CustomerNumber": ["XXXXXX"]
}
CompanyInfo
You only need to supply one of these, but you should add all the info you can.
Field | Description |
---|---|
Name | The name of the company |
ExternalId_DK_CVR_Number | The VAT number in Denmark of the company, can be several |
ExternalId_DK_CVR_APIId | The ApiId in the Danish VAT registry of the company, can be several |
ContactInfo_Email | The contact email of the company, can be several |
ContactInfo_Phone | The contact phonenumber of the company, can be several |
ExternalId_GenericCustomerNumber | An identifier in your own system for this company, can be several |
ExternalId_Vendor_Economic_CustomerNumber | An identifier in your Economic system for this client, can be several |
ExternalId_Vendor_DunBradstreet_DUNSNumber | A DUNS number from DunBradstreet, can be several |
ExternalId_NO_BusinessRegistrationNumber | A Norwegian Business Registration Number, can be several |
ExternalId_GenericBusinessRegistrationNumber | A generic business number, you must supply both a country code and a registration number, can be several |
If a GenericBusinessRegistrationNumber has a country code supported by our system, we will attempt to pull any relevant data from external sources. If for example a norwegian registration number is put in, it will be handled as a ExternalId_NO_BusinessRegistrationNumber would.
All fields in info, except Name, accepts multiple values.
Json representation of CompanyInfo. You only need to supply one of the following pieces of information:
{
"Name": "My Company Client",
"ExternalId_DK_CVR_Number": ["XXXXXXXX"],
"ExternalId_DK_CVR_APIId": ["XXXXXX"],
"ContactInfo_Email": ["XXXXXX"],
"ContactInfo_Phone": ["XXXXXX"],
"ExternalId_GenericCustomerNumber": ["XXXXXX"],
"ExternalId_Vendor_Economic_CustomerNumber": ["XXXXXX"],
"ExternalId_Vendor_DunBradstreet_DUNSNumber": ["XXXXXX"],
"ExternalId_NO_BusinessRegistrationNumber": ["XXXXXX"],
"ExternalId_GenericBusinessRegistrationNumber": [
{
"countryCode": "DK",
"registrationNumber": "XXXXXX"
}
]
}