ObsLeadEngine API Connector

Overview

The ObsLeadEngine API Connector is a component within Obsidione's lead generation infrastructure, which serves as a bridge between the customer information collection webform and our backend software, ensuring that all submitted data is accurately distributed to the relevant companies.

Our LeadEngine API Connector is designed to seamlessly integrate with webforms and platforms that collect customer information, such as contact details, preferences, and any other relevant data points (the LEAD) which is distributed and submitted to the relevant parties. Once the information is submitted by the user and validated by the endpoint, the API connector takes over to ensure this data is properly captured and transmitted.

One of the primary functions of the API connector is to validate and transfer the submitted information. This includes checking for common errors, ensuring data completeness, and verifying that the information adheres to predefined formats. This validation process helps to maintain data integrity and reduces the likelihood of errors in subsequent processing stages.

Beyond just validating the data, the LeadEngine API Connector adds significant value by enhancing the submitted information. It does this by cross-referencing public databases and other resources to append additional relevant details. This could include enriching customer profiles with demographic data, geographic location, or even business information where applicable.

How to Use

To utilize our API Connector, your integration will require a unique API key provided by the partner team at Obsidione. This key is unique and essential for authenticating requests and ensuring secure communication between your webform and our backend systems. Please contact us to obtain your unique API key. LSI key numbers are strong encryption codes which is obtained from the partner team, which is applicable for certain industries.

Please remember to validate the CurrentTimestamp to match the current Norwegian time (DDMMYY MMSSII UTC). If a timestamp is incorrect to server time (with a slight secret security delay), the request will fail with error 500.

We recommend sending the information via Axios to ensure the best compatibility. Please see below for a super-simple example of how to use Axios with the POST method.

import axios from 'axios';

const sendLeadData = async (formData) => {
    try {
        const response = await axios.post('https://api.obsleads.com/leadengine/submitNewLead?reference=externalLeadSubmission', formData, {
            headers: {
                'Authorization': `Bearer YOUR_UNIQUE_API_KEY`,
                'LeadEngineKey': `Bearer YOUR_UNIQUE_CUSTOMER_NO´,
                'CurrentTimestamp': `CURRENT_TIMESTAMP`,
                'LSI1': `Bearer LSI1_KEY_NO`,
                'LSI2': `Bearer LSI2_KEY_NO`,
                'LSI3': `Bearer LSI3_KEY_NO`,
                'Content-Type': 'application/json'
            }
        });

        if (response.status === 200 && response.data.received === true) {
            console.log('Lead data submitted successfully: ', response.data);
        } else {
            console.error('Error submitting lead data: ', response.status, response.message);
        }
    } catch (error) {
        console.error('An error occurred while submitting lead data: ', error.message);
    }
};

// Example usage:
const formData = {
    name: 'John Doe',
    email: 'john.doe@example.com',
    phone: '123-456-7890',
    company: 'Example Corp'
};

const handleFormSubmission = (formName, formEmail, formPhone, formCompany, formCurrentSupplier, ...restOfInformation) => {

  const formData = {
      name: formName, //John Doe
      email: formEmail, //john.doe@example.com
      phone: formPhone, //123-456-7890
      company: formCompany, //Example Corp
      currentSupplier: formCurrentSupplier, //Contoso Inc
      additionalInformation: "Requesting a single use software for three mailboxes and a contact centre for a SMB consisting of 10 users", //additional information
      ...restOfInformation // => generic string to pass on required information
  };

  // validate form information submitted to ensure minimal API errors returned

  sendLeadData(formData);
}

Your request will return a JS array with status code 200 for successful transmissions, and 500 for failed transmissions. Failed transmissions will also contain a error message under the "message" section as well as the specific reason. To prevent submissions from failing, we do recommend to validate all information frontend, making sure the lead relevancy score will stay high.

All submitted leads will be validated backend and is also scored for fraud, giving it an internal score of 0-100. All leads with a score of 20 or less will automatically be discarded and sent to error 500 with error message Invalid dataset.

{status: 200, message: "Successful data transmission", uqTransIdent: "dc01fd0ae686d40b231063a529ab955a"}
{status: 500, message: "Data transmission failed", reason: "Invalid dataset provided", uqTransIdent: "b989d6ce26becb56bd1ed41774c2b98c"}

Please contact us to have a full overview of all possible strings to be passed. The more information, the merrier leads.

Validation of information

To ensure that the ObsAPI will receive valid customer information, and to reduce the risk of receiving error messages during the data transmission, we require that you validate the customer information yourself before forwarding the request to the API. Data will be validated in the API as well, and as a result of this, your request might fail with status code 500.

All information spinning and distrubution takes place after the lead is submitted to Obsidione, based on API criterias and partner agreements. For security purposes, it is not possible to select priority distribution to a specific partner.

Validation examples

For validation of information from Norway, you can use the npm package norsk-validator which supports organisasjonsnummer, KID-nummer, bank account number and Norwegian social security numbers. Remember to never share or pass on sensitive information through our services.

You can find more information about the "norsk-validator" package through the installation page.

const validator = require('norsk-validator');

const orgno = "998447356";

const orgnr = validator.organisasjonsnummer(orgno);

if(orgnr){
return "Organization number exists";
} else {
return "Organization number is not existing";
}

Validation of postal codes

Norway (via Obsidione API)

const axios = require('axios');

const zipCode = "0150";

async function checkZipcode(zipCodeNo) {
  try {
    const response = await axios.get('https://api.obsdn.io/v2/validate/zip/no/' + zipCodeNo);
    const { valid, type, city, country } = response.data;

    // Check if the zip code is valid and of the desired type
    if (valid === "1") {
      console.log(`Valid: ${valid}`);
      console.log(`City: ${city}`);
      console.log(`Country: ${country}`);
    } else {
      console.log(`Zip code provided does not exist`);
    }
  } catch (error) {
    console.error('Error fetching data:', error);
  }
}

if(zipCode){
// => do something fun here
await checkZipcode(zipCode);
}

Sweden (via npm swedish-portal-code-validator)

import { isValid } from 'swedish-postal-code-validator';

const zipCode = response.data.zipCode;
 
isValid('41663') // => true
isValid('32663') // => false

Denmark (via @kevinfrom/danish-zipcodes-api)

import { createZipCodesApi } from '@kevinfrom/danish-zipcodes-api'

const api = createZipCodesApi()

api.searchByZip(6950).then(data => console.log(data))

// Search by name
api.searchByName('Ringkøbing').then(data => console.log(data))

Contact us

This is just example codes and has to be modified into your existing systems. If you have any questions for the implementation or submission processes for external leads, please contact us through support@obsidione.com.

© 2025 Obsidione Norway AS
Leading the way there