Introduction
This documentation contains information about how to authenticate with, and use the open API's provided by Byndle
Authentication
needs to be used with all our api endpoints.
Create token
Send a GET request to the create token endpoint to receive a token that should be used on all other API endpoints.
Use your credentials in the format of username:password in a header named Auth
The returned token should be added as a header to other API requests.
| Header | Value |
|---|---|
| Authorization | Bearer token |
HEADER PARAMETERS
Responses
Response attributes
Lookup
The lookup feature enables you to do a 1-1 lookup of entries in our databases. The lookup feature contains information about persons and their relations, norwegian propertie3s, business information and vehicle information.
Person
Will return enriched person data based on matching of provided data
Request parameters
HEADER PARAMETERS
BODY PARAMETERS
Responses
Response attributes
child attributes
Person extended
Will return extended person data based on matching of provided input.
The provided endpoint will contain data from multiple registers
Request parameters
HEADER PARAMETERS
Responses
Response attributes
child attributes
child attributes
child attributes
child attributes
child attributes
Person phones
Will return phone numbers of identified person based on provided data
Request parameters
HEADER PARAMETERS
Responses
Response attributes
Phone number
Will return person information based on owner of phone number
Request parameters
HEADER PARAMETERS
Responses
Response attributes
Phone number reservation
Will return reservation statuses of the person that is the owner of the phone number
Request parameters
HEADER PARAMETERS
Responses
Response attributes
Business
Will return enriched business data based on given organization number
Request parameters
Possible roles to include:
| Bestyrende reder |
| Bobestyrer |
| Daglig leder/administrerende direktør |
| Deltaker med proratisk ansvar (delt ansvar) |
| Deltaker med solidarisk ansvar (fullt ansvarlig) |
| Forretningsfører |
| Innehaver |
| Komplementar |
| Kontaktperson |
| Nestleder |
| Norsk representant for utenlandsk enhet |
| Observatør |
| Regnskapsfører |
| Revisor |
| Styremedlem |
| Styrets leder |
| Varamedlem |
HEADER PARAMETERS
Responses
Response attributes
child attributes
child attributes
Vehicle
Will return vehicle and owner information based on search input
Request parameters
HEADER PARAMETERS
Responses
Response attributes
Ajourhold
s are for maintaining your existing data. With ajourhold from Byndle you will always have correct and updated data on your customers.
The following documentation is ment for program integrations to add new entries, delete entries and to receive changes from our services.
An account and ajourhold needs to be configured for your account before you can start using these endpoints.
Byndle also provides ajourhold services with file deliveries over SFTP instead of API. Contact us for further information about this.
Our data is updated every night, and changes will be notified via webhooks immediately after the updates are done.
Match levels
Byndle will match the data you provide us with our internal registers. Our matching follows 11 steps that are described below.
Any match level between 2 and 9 will result in us maintaining and updating data about the person.
You can also use this match level to determine if you concider the match to be good enough to update your own registers.
Our matching routines uses SOUNDEX to allow some variations or misspelling in certain variables
| Match level | First name | Last name | Street | House number | Postal code | Birth date |
|---|---|---|---|---|---|---|
| Level 2 | Required | Required | First three letters must match | Required | First 2 digits must match | Required |
| Level 3 | Required | Required | First three letters must match | Not required | First 2 digits must match | Required |
| Level 4 | Required | Required | First three letters must match | Required | All 4 digits must match | Not required |
| Level 5 | Required | Required | First three letters must match | Required | First 2 digits must match | Not required |
| Level 6 | Required | Required | Not required | Not required | First 2 digits mustt match | Required |
| Level 7 | Required | Required | Not required | Not required | First 1 digit must match | Required |
| Level 8 | Required | Required | Not required | Not required | Not required | Required |
| Level 9 | Required | Required | First three letters must match | Not required | All 4 digits must match | Not required |
| Level 10 | Required | Required | First three letters must match | Not required | First 2 digits must match | Not required |
| Level 11 | Required | Required | Not required | Not required | First 2 digits must match | Not required |
| Level 12 | Required | Required | Not required | Not required | Not required | Required |
Person statuses
| id | Description |
|---|---|
| 1 | Bosatt / Aktiv |
| 2 | Utflyttet |
| 3 | Utvandret |
| 4 | Forsvunnet |
| 5 | død |
| 6 | Utgått fødselsnummer korrigret til nytt |
| 7 | Fødselsregistrert |
| 8 | Annulert tilgang |
| 9 | Uregistrert person |
Webhooks
With webhooks configured, Byndle will notify your system when changed occurs to any matched row in the ajourhold.
can only be sent to SSL secured endpoints and accepts Basic Auth Credentials to be configured.
The different types of events that might be triggered on an ajourhold are:
| EventName | Description |
|---|---|
| reservedDm.changed | Change in reservation against direct mail |
| reservedPhoneSale.changed | Change in reservation against phone sales |
| reservedHumOrg.changed | Change in reservation against humanitary organizations |
| buildingType.changed | Change in the registered building type which the person lives or owns |
| mobNr.changed | Change in cellphone number |
| telNr.changed | Change in landline number |
| name.last.changed | Change of last name |
| name.first.changed | Change of first name |
| address.postNr.changed | Change in registered postal code |
| address.dwellingNr.changed | Change in registered dwlling unit |
| address.streetNr.changed | Change in registered street nr |
| address.streetName.changed | Change in registered street name |
| address.full.changed | Contains the full address when any address data is changed |
| sourceMatchLevel.changed | Change in our match level |
| status.changed | Change in person status. See description above |
| entry.removed | |
| entry.added |
Responses
Response attributes
child attributes
child attributes
Add person
For adding single new entries to an existing ajourhold.
The person will be added regardless of matching in our database, since the record might yield a match later.
The returned object will be the record with any changes performed by our data.
Request parameters
HEADER PARAMETERS
Responses
Response attributes
child attributes
Remove person
Removing persons from ajourholds are done with DELETE requests to two different endpoints.
To delete a person based on your own customer identifier (configured as externalId when adding the person):
DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/externalId/{externalId}
To delete a person based don the Byndle ID:
DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/byndleId/{externalId}
HEADER PARAMETERS
Get entries
Returns a paginated reply of all entries in the ajourhold
Request parameters
HEADER PARAMETERS
Responses
Response attributes
child attributes
child attributes
Get changes
Returns paginated reply of all entries that has been changed since the input date parameter.
Request parameters