Byndle AS

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

Introduction

<p> needs to be used with all our api endpoints.</p><br>

Authentication

<p>Send a GET request to the create token endpoint to receive a token that should be used on all other API endpoints.&nbsp;<br><br>Use your credentials in the format of username:password in a header named Auth</p><br><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;"><b>Token</b> <span style="font-size: .7em;"><span style="color: #ec0000; font-size: .7em;">REQUIRED</span> / JSON Object</span> <br><span>The response object will contain a property named token. This should be used in all subsequent requests to the API</span></td></tr></tbody></table></figure><br><p>The returned token should be added as a header to other API requests.</p><br><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><br>

Create token

<p>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.</p><br>

Lookup

<p>Will return enriched person data based on matching of provided data</p><br><p><strong>Request parameters</strong></p><br><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;"><b>firstname</b> <span style="font-size: .7em;">string</span> <br><span>First and / or middle name(s)</span></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;"><b>lastname</b> <span style="font-size: .7em;">string</span> <br><span>Last name</span></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;"><b>fullname</b> <span style="font-size: .7em;">string</span> <br><span>Full name, can be used instead of first and last name</span></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;"><b>address</b> <span style="font-size: .7em;"><span style="color: #ec0000; font-size: .7em;">REQUIRED</span> / string</span> <br><span>Streetname plus number and letter (if available)</span></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;"><b>birthdate</b> <span style="font-size: .7em;">date</span> <br><span>Birthdate in format yyyy-mm-dd</span></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;"><b>postcode</b> <span style="font-size: .7em;">string</span> <br><span>&nbsp;</span></td></tr></tbody></table></figure><br>

Person

<p>Will return extended person data based on matching of provided input.<br>The provided endpoint will contain data from multiple registers</p><br><p><strong>Request parameters</strong></p><br>

Person extended

<p>Will return phone numbers of identified person based on provided data</p><br><p><strong>Request parameters</strong></p><br>

Person phones

<p>Will return person information based on owner of phone number</p><br><p><strong>Request parameters</strong></p><br>

Phone number

<p>Will return reservation statuses of the person that is the owner of the phone number</p><br><p><strong>Request parameters</strong></p><br>

Phone number reservation

<p>Will return enriched business data based on given organization number</p><br><p><strong>Request parameters</strong></p><br><p>Possible roles to include:</p><br><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><br>

Business

<p>Will return vehicle and owner information based on search input</p><br><p><strong>Request parameters</strong></p><br>

Vehicle

<p>s are for maintaining your existing data. With ajourhold from Byndle you will always have correct and updated data on your customers.<br>The following documentation is ment for program integrations to add new entries, delete entries and to receive changes from our services.<br><br>An account and ajourhold needs to be configured for your account before you can start using these endpoints.<br><br>Byndle also provides ajourhold services with file deliveries over SFTP instead of API. Contact us for further information about this.&nbsp;</p><br><p>Our data is updated every night, and changes will be notified via webhooks immediately after the updates are done.</p><br>

Ajourhold

<p>Byndle will match the data you provide us with our internal registers. Our matching follows 11 steps that are described below.<br>Any match level between 2 and 9 will result in us maintaining and updating data about the person.&nbsp;</p><br><p>You can also use this match level to determine if you concider the match to be good enough to update your own registers.</p><br><p>Our matching routines uses SOUNDEX to allow some variations or misspelling in certain variables&nbsp;</p><br><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><br>

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><br>

Person statuses

<p>With webhooks configured, Byndle will notify your system when changed occurs to any matched row in the ajourhold.&nbsp;</p><br><p> can only be sent to SSL secured endpoints and accepts Basic Auth Credentials to be configured.</p><br><p>The different types of events that might be triggered on an ajourhold are:</p><br><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><br>

Webhooks

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

Add person

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

Remove person

<p>Returns a paginated reply of all entries in the ajourhold&nbsp;</p><br><p><strong>Request parameters</strong></p><br>

Get entries

<p>Returns paginated reply of all entries that has been changed since the input date parameter.</p><br><p><strong>Request parameters</strong></p><br>

Get changes

Byndle

<p class="slate-p"><p class="slate-p">This documentation contains information about how to authenticate with, and use the open API&apos;s provided by Byndle</p><p class="slate-p"><br /></p></p>

<p class="slate-p"><p class="slate-p"> needs to be used with all our api endpoints.</p><p class="slate-p"><br /></p></p>

<p class="slate-p"><p class="slate-p">Send a GET request to the create token endpoint to receive a token that should be used on all other API endpoints. <br /><br />Use your credentials in the format of username:password in a header named Auth</p><p class="slate-p"><br /></p><table class="slate-table"><colgroup contenteditable="false"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">Title</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Required?</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Type</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Description</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">Token</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">yes</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">JSON Object</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">The response object will contain a property named token. This should be used in all subsequent requests to the API</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><table class="slate-table"><colgroup contenteditable="false"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">Response attributes</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Token</strong> <span style="color:rgb(236, 0, 0);font-size:.7em" class="slate-fontSize"><span style="color:rgb(236, 0, 0);font-size:.7em" class="slate-color">REQUIRED</span></span><span style="font-size:.7em" class="slate-fontSize"> / JSON Object</span> <br />The response object will contain a property named token. This should be used in all subsequent requests to the API</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p"><br /></p><p class="slate-p">The returned token should be added as a header to other API requests.</p><p class="slate-p"><br /></p><table class="slate-table"><colgroup contenteditable="false"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><th class="slate-th">Header </th><th class="slate-th">Value</th></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">Authorization</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Bearer token</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p"><br /></p></p>

Content-Type

token

userPermissions

user

expires

issued

customer

anonymousAccessToken

successfulLogin

requires2FA

maskedEmail

maskedPhone

hasActiveSubcription

<p></p><p>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.</p><p><br /></p><p></p>

<p></p><p>s are for maintaining your existing data. With ajourhold from Byndle you will always have correct and updated data on your customers.<br />The following documentation is ment for program integrations to add new entries, delete entries and to receive changes from our services.<br /><br />An account and ajourhold needs to be configured for your account before you can start using these endpoints.<br /><br />Byndle also provides ajourhold services with file deli</p>