API Integration of AXN Batch

Here are the different AXN Batch use cases, along with instructions on how to perform each one.

Customer Cleanse

Validate user identity, eliminate bad actors and inactive accounts to improve marketing efficiency and customer satisfaction.

Required Attributes:

  • Full Name
  • International Address
  • Date of Birth
  • Email
  • Phone
  • SSN9 (Optional)

  • Click here to download sample input

    Unique ID

    Assign a SSN-alternative ID (LexID), consolidate duplicates, and create a holistic view of customers across directories using Lexis Nexis’ LexID.

    Required Attributes:

  • Full Name
  • International Address
  • Date of Birth
  • SSN9 (Optional)

  • Click here to download sample input

    MFA Security

    Evaluate risk before MFA rollout by checking emails and phone numbers for high-risk indicators, ensuring secure user authentication.

    Required Attributes:

  • Full Name
  • International Address
  • Phone

  • Click here to download sample input

    B2B User Cleanse

    Ensure only active users from partners' firms access your systems by verifying email status and company information.

    Required Attributes:

  • Email

  • Click here to download sample input

    API Integration of AXN Batch


    1. Upload File

    Upload your file to create a new BatchID

    (POST) https://prod.axn-batch.iddataweb.com/axn-batch/job/file/upload

    To create a new batchID


    var axios = require('axios')
    
    var user = 'Your Batch Service API Key';
    var password = 'Your Batch Service Shared Secret';
    
    var base64encodedData = Buffer.from(user + ':' + password).toString('base64');
    
    var request = async () => {
      var response = await axios({
        url: 'https://prod.axn-batch.iddataweb.com/axn-batch/job/file/upload',
        method: 'post',
        params: {
          "contact-email": '[email protected]',
          "file-format": 'csv'
        },
        data: {
          file: "" // Use HTML formData to post your file
        }
        headers: {
          'Content-Type': 'multipart/form-data; boundary=----WebKitFormBoundaryE19zNvXGzXaLvS5C', // This for boundary is just an example and should not be copied. 
          'Cache-Control': 'no-cache',
          Authorization: 'Basic ' + base64encodedData
        }
      })
      console.log(response.data)
    }
    request();
    

    Response


    {
        "batchId": "c1e58297-77d0-4ca0-af25-903ad3f366b0",
        "jobStatus": "FILE_VALIDATED"
    }
    

    2. Start Batch Processing Job

    Start a batch processing job by BatchID.

    (POST) https://prod.axn-batch.iddataweb.com/axn-batch/job/start

    To start your batch job


    var data = {
      // Unique identifier for the batch job.
      "batchID": "c1e58297-77d0-4ca0-af25-903ad3f366b0",
    
      // Parameters for the job.
      "jobParams": {
        // Specifies where the output file will be stored. Default is "S3".
        "FILE_SOURCE": "S3",
    
        // Specifies the output file format. Options include "CSV" or "TSV".
        "OUTPUT_FILE_FORMAT": "CSV",
    
        // Name of the output file.
        "OUTPUT_FILE_NAME": "user_data_output.csv",
    
        // List of input columns which should be echoed back in the output.
        // Use "*" to include all input columns.
        "INPUT_COLUMNS_PERSIST": ["name", "email"],
    
        // Controls if input data should be included in the output.
        // "true" = included, "false" = omitted.
        "OUTPUT_USER_ATTRIBUTE": true,
    
        // Controls if acquired attributes should be included in the output.
        // "true" = included, "false" = omitted.
        "OUTPUT_ACQUIRED_ATTRIBUTE": true,
    
        // Controls if user assertions should be included in the output.
        // "true" = included, "false" = omitted.
        "OUTPUT_USER_ASSERTIONS": true
      }
    }
    
    var axios = require('axios')
    
    var user = 'Your Batch Service API Key';
    var password = 'Your Batch Service Shared Secret';
    
    var base64encodedData = Buffer.from(user + ':' + password).toString('base64');
    
    var request = async () => {
      var response = await axios({
        url: 'https://prod.axn-batch.iddataweb.com/batch/job/start',
        method: 'post',
        data: data,
        headers: {
          'Content-Type': 'application/json',
          'Cache-Control': 'no-cache',
          Authorization: 'Basic ' + base64encodedData,
        }
      })
    	console.log(response.data)
    }
    request();
    

    Response


    {
        "batchId": "c1e58297-77d0-4ca0-af25-903ad3f366b0",
        "jobStatus": "STARTED",
        "jobParams": {
            "INPUT_FILE_FORMAT": "CSV",
            "OUTPUT_FILE_NAME": "batchResult-1721612135",
            "OUTPUT_ACQUIRED_ATTRIBUTE": "true",
            "OUTPUT_FILE_FORMAT": "csv",
            "FILE_SOURCE": "S3",
            "OUTPUT_USER_ATTRIBUTE": "true",
            "CONTACT_EMAIL": "[email protected]",
            "OUTPUT_USER_ASSERTIONS": "true",
            "INPUT_COLUMNS_PERSIST": "*"
        },
        "startTime": "2024-07-22T01:35:34.762+0000"
    }