Byndle AS

This documentation contains information about how to authenticate with, and use the open API's provided by Byndle

Introduction

needs to be used with all our api endpoints.

Authentication

Send a GET request to the create token endpoint to receive a token that should be used on all other API endpoints.&nbsp; Use your credentials in the format of username:password in a header named Auth <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="response-editor-view" style="border-width:0;" id="55342b64-a62b-48a2-91ca-73ebc73f8cd3-response"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td></tr><tr><td>Token</td><td>yes</td><td>JSON Object</td><td>The response object will contain a property named token. This should be used in all subsequent requests to the API</td></tr></tbody></table><table style="border: 0;" id="55342b64-a62b-48a2-91ca-73ebc73f8cd3-response" contenteditable="false" class="response-publish-view"><tbody><tr><td>Response attributes</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">Token REQUIRED / JSON Object The response object will contain a property named token. This should be used in all subsequent requests to the API</td></tr></tbody></table></figure> The returned token should be added as a header to other API requests. <figure class="table"><table><thead><tr><th>Header&nbsp;</th><th>Value</th></tr></thead><tbody><tr><td>Authorization</td><td>Bearer token</td></tr></tbody></table></figure>

Create token

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.

Lookup

Will return enriched person data based on matching of provided data Request parameters <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="response-editor-view" style="border-width:0;" id="4add3abf-95e4-4255-a984-9ba6895a7c7c-response"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>firstname</td><td>no</td><td>string</td><td>First and / or middle name(s)</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>lastname</td><td>no</td><td>string</td><td>Last name</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>fullname</td><td>no</td><td>string</td><td>Full name, can be used instead of first and last name</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>address</td><td>yes</td><td>string</td><td>Streetname plus number and letter (if available)</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>birthdate</td><td>no</td><td>date</td><td>Birthdate in format yyyy-mm-dd</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>postcode</td><td>no</td><td>string</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table><table style="border: 0;" id="4add3abf-95e4-4255-a984-9ba6895a7c7c-response" contenteditable="false" class="response-publish-view"><tbody><tr><td>Response attributes</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">firstname string First and / or middle name(s)</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">lastname string Last name</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">fullname string Full name, can be used instead of first and last name</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">address REQUIRED / string Streetname plus number and letter (if available)</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">birthdate date Birthdate in format yyyy-mm-dd</td></tr><tr><td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">postcode string &nbsp;</td></tr></tbody></table></figure>

Person

Will return extended person data based on matching of provided input. The provided endpoint will contain data from multiple registers Request parameters

Person extended

Will return phone numbers of identified person based on provided data Request parameters

Person phones

Will return person information based on owner of phone number Request parameters

Phone number

Will return reservation statuses of the person that is the owner of the phone number Request parameters

Phone number reservation

Will return enriched business data based on given organization number Request parameters Possible roles to include: <figure class="table"><table><thead><tr><th>&nbsp;</th></tr></thead><tbody><tr><td>Bestyrende reder</td></tr><tr><td>Bobestyrer</td></tr><tr><td>Daglig leder/administrerende direktør</td></tr><tr><td>Deltaker med proratisk ansvar (delt ansvar)</td></tr><tr><td>Deltaker med solidarisk ansvar (fullt ansvarlig)</td></tr><tr><td>Forretningsfører</td></tr><tr><td>Innehaver</td></tr><tr><td>Komplementar</td></tr><tr><td>Kontaktperson</td></tr><tr><td>Nestleder</td></tr><tr><td>Norsk representant for utenlandsk enhet</td></tr><tr><td>Observatør</td></tr><tr><td>Regnskapsfører</td></tr><tr><td>Revisor</td></tr><tr><td>Styremedlem</td></tr><tr><td>Styrets leder</td></tr><tr><td>Varamedlem</td></tr></tbody></table></figure>

Business

Will return vehicle and owner information based on search input Request parameters

Vehicle

Lists

Create

Filter

Apply Filter

Status

Confirm

Order

Download

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.&nbsp; Our data is updated every night, and changes will be notified via webhooks immediately after the updates are done.

Ajourhold

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.&nbsp; 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&nbsp; <figure class="table"><table><thead><tr><th>Match level</th><th>First name</th><th>Last name</th><th>Street</th><th>House number</th><th>Postal code</th><th>Birth date</th></tr></thead><tbody><tr><td>Level 2</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Required</td><td>First 2 digits must match</td><td>Required</td></tr><tr><td>Level 3</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Not required</td><td>First 2 digits must match</td><td>Required</td></tr><tr><td>Level 4</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Required</td><td>All 4 digits must match</td><td>Not required</td></tr><tr><td>Level 5</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Required</td><td>First 2 digits must match</td><td>Not required</td></tr><tr><td>Level 6</td><td>Required</td><td>Required</td><td>Not required</td><td>Not required</td><td>First 2 digits mustt match</td><td>Required</td></tr><tr><td>Level 7</td><td>Required</td><td>Required</td><td>Not required</td><td>Not required</td><td>First 1 digit must match</td><td>Required</td></tr><tr><td>Level 8</td><td>Required</td><td>Required</td><td>Not required</td><td>Not required</td><td>Not required</td><td>Required</td></tr><tr><td>Level 9</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Not required</td><td>All 4 digits must match</td><td>Not required</td></tr><tr><td>Level 10</td><td>Required</td><td>Required</td><td>First three letters must match</td><td>Not required</td><td>First 2 digits must match</td><td>Not required</td></tr><tr><td>Level 11</td><td>Required</td><td>Required</td><td>Not required</td><td>Not required</td><td>First 2 digits must match</td><td>Not required</td></tr><tr><td>Level 12</td><td>Required</td><td>Required</td><td>Not required</td><td>Not required</td><td>Not required</td><td>Required</td></tr></tbody></table></figure>

Match levels

<figure class="table"><table><thead><tr><th>id</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>Bosatt / Aktiv</td></tr><tr><td>2</td><td>Utflyttet</td></tr><tr><td>3</td><td>Utvandret</td></tr><tr><td>4</td><td>Forsvunnet</td></tr><tr><td>5</td><td>død</td></tr><tr><td>6</td><td>Utgått fødselsnummer korrigret til nytt</td></tr><tr><td>7</td><td>Fødselsregistrert</td></tr><tr><td>8</td><td>Annulert tilgang</td></tr><tr><td>9</td><td>Uregistrert person</td></tr></tbody></table></figure>

Person statuses

With webhooks configured, Byndle will notify your system when changed occurs to any matched row in the ajourhold.&nbsp; 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: <figure class="table"><table><thead><tr><th>EventName</th><th>Description</th></tr></thead><tbody><tr><td>reservedDm.changed</td><td>Change in reservation against direct mail</td></tr><tr><td>reservedPhoneSale.changed</td><td>Change in reservation against phone sales</td></tr><tr><td>reservedHumOrg.changed</td><td>Change in reservation against humanitary organizations</td></tr><tr><td>buildingType.changed</td><td>Change in the registered building type which the person lives or owns</td></tr><tr><td>mobNr.changed</td><td>Change in cellphone number</td></tr><tr><td>telNr.changed</td><td>Change in landline number</td></tr><tr><td>name.last.changed</td><td>Change of last name</td></tr><tr><td>name.first.changed</td><td>Change of first name</td></tr><tr><td>address.postNr.changed</td><td>Change in registered postal code</td></tr><tr><td>address.dwellingNr.changed</td><td>Change in registered dwlling unit</td></tr><tr><td>address.streetNr.changed</td><td>Change in registered street nr</td></tr><tr><td>address.streetName.changed</td><td>Change in registered street name</td></tr><tr><td>address.full.changed</td><td>Contains the full address when any address data is changed</td></tr><tr><td>sourceMatchLevel.changed</td><td>Change in our match level</td></tr><tr><td>status.changed</td><td>Change in person status. See description above</td></tr><tr><td>entry.removed</td><td>&nbsp;</td></tr><tr><td>entry.added</td><td>&nbsp;</td></tr></tbody></table></figure>

Webhooks

For adding single new entries to an existing ajourhold.&nbsp; The person will be added regardless of matching in our database, since the record might yield a match later.&nbsp; The returned object will be the record with any changes performed by our data.&nbsp; Request parameters

Add person

Removing persons from ajourholds are done with DELETE requests to two different endpoints.&nbsp; To delete a person based on your own customer identifier (configured as externalId when adding the person): <code>DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/externalId/{externalId}</code> To delete a person based don the Byndle ID: <code>DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/byndleId/{externalId}</code>

Remove person

Returns a paginated reply of all entries in the ajourhold&nbsp; Request parameters

Get entries

Returns paginated reply of all entries that has been changed since the input date parameter. Request parameters

Get changes

Byndle

Production

SandBox

This documentation contains information about how to authenticate with, and use the open API&apos;s provided by Byndle

Tab 1

needs to be used with all our api endpoints.

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.

Step 1; create the list.

MissionName

MissionType

Authorization

StatusText

ErrorMessage

MissionId

Step 2; setup the filter.This one has lots of sub steps.Start by getting the mission we just created to get the <div class="slate-div"></div>relevant “FilterId”.

Start by getting the mission we just created to get the 

missionId

statusText

workStatus

workStatusDesc

missionMode

Complete the list, take note if the value in the <code class="slate-code">id</code> field of the response here. It&apos;s needed for the next step.

Complete the list, take note if the value in the 

 field of the response here. It's needed for the next step.

gross

orderId

transactionId

reference

amount

redirectUrl

status

gateway

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.

Sections