IDMaml

v1.4.0 Updated: Friday, October 28, 2022

Welcome to the IDMaml RESTful API. You can use our API to access all of IDMaml's services.

TEST URL: {{API_URL}} (All the examples in this documentation are based on Test Environment)

Download: Postman Collection

Overview

IDMaml is designed to help minimize the risks associated with money laundering and other illegal activities.

IDMaml platform and risk-mitigation solutions will help your organization build a robust compliance program while substantially reducing fraud and loss.

Getting Started

If you have any questions or comments, please let us know via our Support Portal.

Knowledge Base

COMMUNICATION METHODOLOGY

The IDMaml API methodology is organized into four main sections:

  • End-Point Test Method enables you to verify the accessibility of our API.
  • Authentication Test Method enables you to verify the validity of the assigned credentials.
  • Token Generation Method enables you to generate the access token using the provided credentials. The time period that the Token will be valid is determined by IDMERIT.
  • Verification Method enables you to perform verifications and retrieve results as:
    • Match
    • Partial Match
    • No Match
AUTHENTICATION METHODOLOGY

As stated above, the IDMaml API authentication framework is built upon token-based authentication:

  • The Username and Password provided by IDMERIT to the Client.
  • The user and password posted to IDMaml API via to request the API to receive an encoded access Token.
  • This token must be used in all subsequent Authorization headers from the Client side API.
Date Of Birth Format

YYYY-MM-DD

Gender
Gender Options
femalef
malem
Country Code Format

We support only ISO 3166-1 alpha 2 country codes. Please visit this link to know more about country codes

ERROR CODES

HTTP Error Codes
Code Description
200 - OK The request was successful. If you are getting unexpected results, please check any Status or Error messages that have been returned in the response. If you believe there may be a problem, please raise a ticket with our Support team at https://idmerit.freshdesk.com/support/tickets/new.
400 - Bad Request The request could not be understood by the server. Please ensure the request is in the appropriate format and all necessary headers have been included.
403 - Forbidden The request was valid, but the requestor does not have appropriate permissions. Please ensure your username is correct and your access token is still valid. If your access token has expired, you may need to reauthenticate your credentials to get a new token.
415 - Unsupported Media Type The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.
500 - Internal Server Error There was a back-end error when processing the request. Please ensure your request is in the correct format and retry. If you receive this error again, please raise a ticket with our Support team at https://idmerit.freshdesk.com/support/tickets/new.
522 - Origin Connection Time-out There was a back-end error when processing the request. Please resubmit the request. If you receive this error again, please raise a ticket with our Support team at https://idmerit.freshdesk.com/support/tickets/new.
SOURCE/OTHER ERRORS

Please contact our support team at https://idmerit.freshdesk.com/support/tickets/new

API Description

 

Ping Test

GET {{API_URL}}/v1.4/ping
HEADERS
Content-Type
application/json
Example Request
Example Response
200 OK

Generate Token

POST {{API_URL}}/v1.4/genToken
HEADERS
Content-Type
application/x-www-form-urlencoded
  • username
  • password


  • BODYurlencoded
    Key Value
    username {{username}}
    required
    password {{password}}
    required

    Example Request
    Example Response
    200 OK

    Check Token / Authentication

    GET {{API_URL}}/v1.4/auth
    HEADERS
    Authorization
    Bearer {{token}}
    Example Request
    Example Response
    200 OK

    Person Verification Service

    POST {{API_URL}}/v1.4/verify
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • first_name
  • last_name
  • name_type

  • Other fields you are able to match against are:

  • middle_name
  • gender
  • dob
  • age
  • address
  • city
  • state
  • zip
  • country

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    first_name {{first_name}}
    required
    last_name {{last_name}}
    required
    middle_name {{middle_name}}
    optional
    gender {{gender}}

    m / M / f / F / male / MALE / female / FEMALE

    optional
    dob {{dob}}

    yyyy-mm-dd

    optional
    age {{age}}
    optional
    address {{address}}
    optional
    city {{city}}
    optional
    state {{state}}
    optional
    zip {{zip}}
    optional
    country {{country}}
    optional
    name_type {{name_type}}

    p / P / c / C

    required
    Note :
    *Please enter either age or dob

    Example

    first_name
    :
    WILLIAM
    middle_name
    :
    Jefferson
    last_name
    :
    CLINTON
    dob
    :
    1946-08-19
    name_type
    :
    p
    request_id
    :
    00001
    address
    :
    address
    city
    :
    Greensboro
    state
    :
    North Carolina
    country
    :
    US
    gender
    :
    male
    Example Request
    Example Response
    200 OK

    Company Verification Service

    POST {{API_URL}}/v1.4/verify
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • company_name
  • name_type

  • Other fields you are able to match against are:

  • address
  • city
  • state
  • zip
  • country

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    company_name {{company_name}}
    required
    name_type {{name_type}}

    p / P / c / C

    required
    address {{address}}
    optional
    city {{city}}
    optional
    state {{state}}
    optional
    zip {{zip}}
    optional
    country {{country}}
    optional

    Example

    company_name
    :
    Oracle
    address
    :
    500 ORACLE PARKWAY, MAIL STOP 5 OP 7
    city
    :
    Greensboro
    state
    :
    North Carolina
    country
    :
    US
    request_id
    :
    00001
    name_type
    :
    c
    Example Request
    Example Response
    200 OK

    Person Info(JSON) Service

    POST {{API_URL}}/v1.4/info
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • first_name
  • last_name
  • name_type

  • Other fields you are able to match against are:

  • dob
  • age
  • middle_name
  • response_type
  • monitoring

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    first_name {{first_name}}
    required
    last_name {{last_name}}
    required
    dob {{dob}}

    yyyy-mm-dd

    optional
    age {{age}}
    optional
    middle_name {{middle_name}}
    optional
    response_type {{response_type}}

    json / JSON

    optional
    name_type {{name_type}}

    p / P / c / C

    required
    monitoring {{monitoring}}

    (string) true / false

    optional
    Note :
    *Please enter either age or dob

    Example

    first_name
    :
    WILLIAM
    middle_name
    :
    Jefferson
    last_name
    :
    CLINTON
    dob
    :
    1946-08-19
    name_type
    :
    p
    country
    :
    US
    request_id
    :
    00001
    monitoring
    :
    false
    response_type
    :
    json
    Example Request
    Example Response
    200 OK

    Company Info(JSON) Service

    POST {{API_URL}}/v1.4/info
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • company_name
  • name_type

  • Other fields you are able to match against are:

  • response_type
  • monitoring

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    company_name {{company_name}}
    required
    name_type {{name_type}}

    p / P / c / C

    required
    response_type {{response_type}}

    json / JSON

    optional
    monitoring {{monitoring}}

    true / false /

    optional

    Example

    company_name
    :
    Oracle
    name_type
    :
    c
    country
    :
    US
    request_id
    :
    00001
    monitoring
    :
    false
    response_type
    :
    json
    Example Request
    Example Response
    200 OK

    Person Info(PDF) Service

    POST {{API_URL}}/v1.4/info
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • first_name
  • last_name
  • name_type

  • Other fields you are able to match against are:

  • dob
  • age
  • middle_name
  • response_type
  • monitoring

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    first_name {{first_name}}
    required
    last_name {{last_name}}
    required
    dob {{dob}}

    yyyy-mm-dd

    optional
    age {{age}}
    optional
    middle_name {{middle_name}}
    optional
    response_type {{response_type}}

    pdf / PDF

    optional
    name_type {{name_type}}

    p / P / c / C

    required
    monitoring {{monitoring}}

    (string) true / false

    optional
    Note :
    *Please enter either age or dob
    *Response>>JSON Decode>>Take the data>>Base64 decode>>Save the response from decode to PDF

    Steps to convert the API response to PDF

    1. Copy the Response of the API
    2. Pass it to JSON Decoder to ensure proper JSON
    3. Take the Data
    4. Pass it through Base64 Decoder
    5. Save the result as PDF

    Example

    first_name
    :
    WILLIAM
    middle_name
    :
    Jefferson
    last_name
    :
    CLINTON
    dob
    :
    1946-08-19
    name_type
    :
    p
    country
    :
    US
    request_id
    :
    00001
    monitoring
    :
    false
    response_type
    :
    pdf
    Example Request
    Example Response
    200 OK

    Company Info(PDF) Service

    POST {{API_URL}}/v1.4/info
    HEADERS
    Content-Type
    application/x-www-form-urlencoded
    Authorization
    Bearer {{token}}

    The required fields to perform a match are:

  • request_id
  • company_name
  • name_type

  • Other fields you are able to match against are:

  • response_type
  • monitoring

  • BODYurlencoded
    Key Value
    request_id {{request_id}}
    required
    company_name {{company_name}}
    required
    name_type {{name_type}}

    p / P / c / C

    required
    response_type {{response_type}}

    pdf / PDF

    optional
    monitoring {{monitoring}}

    true / false

    optional
    Note :
    Response>>JSON Decode>>Take the data>>Base64 decode>>Save the response from decode to PDF

    Steps to convert the API response to PDF

    1. Copy the Response of the API
    2. Pass it to JSON Decoder to ensure proper JSON
    3. Take the Data
    4. Pass it through Base64 Decoder
    5. Save the result as PDF

    Example

    company_name
    :
    Oracle
    name_type
    :
    c
    country
    :
    US
    request_id
    :
    00001
    monitoring
    :
    false
    response_type
    :
    pdf
    Example Request
    Example Response
    200 OK


    Monitoring System – Webhook

    IDMERIT offers an optional API webhook that allows IDMeirt to automatically send PM (Portfolio Monitoring) alerts to client endpoints. This convenience feature removes the need for clients to code for extra API calls to call back into IDMerit to retrieve alerts.

    To automatically receive alerts, IDMerit can be configured to point to a client endpoint (webhook). For integration, IDMerit supports REST API endpoints with login in credentials for added security.

    Requirement for webhook

    Webhook URL: USER ENDPOINT URL

    Authentication: Basic Auth

    Parameters:

    • Username
    • Password

    IDMerit Push notification for the Portfolio monitoring:

    webhook-monitoring