Comprehensive Guide to Using the Blacklist Check API

Introduction

The Blacklist Check API provided by ADVANCE is an essential tool for businesses and organizations to verify and screen individuals against various blacklists. This service helps ensure the integrity and security of your operations by detecting potentially fraudulent or risky individuals. This guide provides an overview of how to use the Blacklist Check API, common issues, and troubleshooting steps.

Overview of the Blacklist Check API

The Blacklist Check API allows users to submit queries to verify if an individual is listed in any blacklist databases. The API is designed to process identification details such as names, ID numbers, and phone numbers to deliver accurate and reliable blacklist status.

How to Use the Blacklist Check API

1. Endpoint and Headers:

   • Endpoint: https://api.advance.ai/openapi/blacklist-check/v1
   • Headers: Include your access token and set the content type to application/json.

2. Parameters:

   • name: The full name of the individual to be checked.
   • idNumber: The 16-digit ID number (NIK) of the individual.
   • phoneNumber: The phone number of the individual, including country code and area code.

3. Sample Request:

   json

    

   { "name": "SITI CHURIAH", "idNumber": "3173054609790011", "phoneNumber": { "countryCode": "+62", "areaCode": "", "number": "85775095213" } }

   Curl Example:

   bash

    

   curl -X POST \ -H "X-ACCESS-TOKEN: {Your Access Token}" \ -H "Content-Type: application/json" \ -d '{"name":"SITI CHURIAH","idNumber":"3173054609790011","phoneNumber":{"countryCode":"+62","areaCode":"","number":"85775095213"}}' \ "https://api.advance.ai/openapi/blacklist-check/v1"

Common Issues and Troubleshooting

1. Sample Issue:

   • Problem: The API request returns an error code "PARAMETER_ERROR" with the message "Invalid ID number."

2. Diagnosis of the Issue:

   • Error Message: The error indicates that the ID number format is incorrect. The ID number must be a 16-digit NIK.
   • Cause: Common causes include entering an ID number with incorrect length or non-numeric characters.

3. Solution of the Issue:

   • Correct Parameter Formats: Ensure that the ID number is a valid 16-digit number. Double-check the format before making the API request.
   • Example of Correct Format:
     json

      

     { "name": "SITI CHURIAH", "idNumber": "3173054609790011", "phoneNumber": { "countryCode": "+62", "areaCode": "", "number": "85775095213" } }

Obtaining an Access Token

To access the Blacklist Check API, you need an Access Token. Here’s how to obtain one:

1. Endpoint: https://api.advance.ai/openapi/auth/ticket/v1/generate-token

2. Parameters:

   • accessKey: Your access key
   • timestamp: 13-digit-long timestamp
   • signature: SHA256 encrypted combination of accessKey, secretKey, and timestamp
   • periodSecond (optional): Validity period (defaults to 3600 seconds)

3. Sample Request:

   bash

    

   curl -X POST \ -H "Content-Type: application/json" \ -d '{"accessKey":"yourAccessKey","signature":"yourSignature","timestamp":1648785145789,"periodSecond":3600}' \ "https://api.advance.ai/openapi/auth/ticket/v1/generate-token"

Further Assistance

If you continue to experience issues despite following the guidelines provided, please contact our support team for further assistance:

• Email: help@advance.ai
• Submit a Ticket: Via ADVANCE.AI Support

Our support team is available to help resolve any issues and ensure you can effectively use the Blacklist Check API.

This guide aims to provide a clear understanding of the Blacklist Check API, its usage, common issues, and troubleshooting steps to ensure effective and reliable blacklist verification for your organization.