LANGUAGE

IDMsocial

V2.1 Updated: Wednesday, July 10, 2024

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

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

Download:

Overview

Make trustworthy customer approvals by calculating an individual's risk score. Monitor data, manage risk to combat fraud and reduce financial theft in real-time. Detect account fraud and fake signups, determine suspicious activities and identify high-risk scoring customers. Mitigate data breaches by preventing fraudsters to open accounts with stolen identities. Ensure that clients you’re onboarding are legitimate by leveraging multiple data sources.

Fight Fraud Using a Combination of Email & Phone data Points.
Identify and Block Stolen and Fake Identities.
Assess Risk Score Based on Email Maturity.

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

Ping Test

GET {{API_URL}}/v2.1/ping

					curl -X GET \
'{{API_URL}}/v2.1/ping'

Body
Headers(1)

{
    "result": true,
    "status_code": 200,
    "message": "Successfully Connected."
}

Generate Token

POST {{API_URL}}/v2.1/genToken

HEADERS

Content-Type

application/x-www-form-urlencoded

BODY urlencoded

username

password

					curl -X POST \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'username={{username}}' \
-d 'password={{password}}' \
'{{API_URL}}/v2.1/genToken'

Body
Headers(1)

{
    "result": true,
    "status_code": 200,
    "issued": "{{0000-00-00T00:00:00.000000Z}}",
    "expires": "{{0000-00-00 00:00:00}}",
    "access_token": "{{access_token}}",
    "token_type": "bearer",
    "username": "{{username}}",
}

Check Token / Authentication

GET {{API_URL}}/v2.1/auth

HEADERS

Authorization

Bearer {{token}}

					curl -X GET \
-H 'Authorization: Bearer {{token}}' \
'{{API_URL}}/v2.1/auth'

Body
Headers(1)

{
    "result": true,
    "status_code": 200,
    "message": "Token is valid.",
    "expired_at": "{{0000-00-00 00:00:00}}",
}

Social Service

POST {{API_URL}}/v2.1/service

HEADERS

Authorization

Bearer {{token}}

Content-Type

application/x-www-form-urlencoded

The required fields to perform a match are:

request_id

Other fields you are able to match against are:

phone

BODY urlencoded

request_id

required

optional

phone

optional

Note: At least one parameter required from email and phone.

					curl -X POST \
-H 'Authorization: Bearer {{token}}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'request_id={{request_id}}' \
-d 'email={{email}}' \
-d 'phone={{phone}}' \
'{{API_URL}}/v2.1/service'

					
					
				

Body
Headers(1)

{
    "status": true,
    "status_code": 200,
    "message": "Get data",
    "data": {
        "email_details": {
            "email": "{{email}}",
            "account_details": {
                "apple": {
                    "registered": true
                },
                "ebay": {
                    "registered": true
                },
                "facebook": {
                    "registered": false,
                    "url": null,
                    "name": null,
                    "photo": null
                },
                "flickr": {
                    "registered": false
                },
                "foursquare": {
                    "registered": false
                },
                "github": {
                    "registered": false
                },
                "google": {
                    "registered": true,
                    "photo": "{{photo}}"
                },
                "gravatar": {
                    "registered": false
                },
                "instagram": {
                    "registered": true
                },
                "lastfm": {
                    "registered": false
                },
                "linkedin": {
                    "registered": true,
                    "url": "{{url}}",
                    "name": "{{name}}",
                    "company": "{{company}}",
                    "title": "{{title}}",
                    "location": "{{location}}",
                    "website": null,
                    "twitter": null,
                    "photo": "{{photo}}"
                },
                "microsoft": {
                    "registered": false
                },
                "myspace": {
                    "registered": false
                },
                "pinterest": {
                    "registered": false
                },
                "skype": {
                    "registered": false,
                    "country_code": null,
                    "city": null,
                    "gender": null,
                    "name": null,
                    "id": null,
                    "handle": null,
                    "bio": null,
                    "age": null,
                    "language": null,
                    "state": null,
                    "photo": null
                },
                "spotify": {
                    "registered": false
                },
                "tumblr": {
                    "registered": false
                },
                "twitter": {
                    "registered": true
                },
                "vimeo": {
                    "registered": false
                },
                "weibo": {
                    "registered": false
                },
                "yahoo": {
                    "registered": true
                }
            }
        },
        "phone_details": {
            "number": "{{number}}",
            "account_details": {
                "facebook": {
                    "registered": false
                },
                "google": {
                    "registered": false
                },
                "twitter": {
                    "registered": false
                },
                "instagram": {
                    "registered": false
                },
                "yahoo": {
                    "registered": null
                },
                "whatsapp": {
                    "registered": false,
                    "photo": null,
                    "last_seen": null
                },
                "telegram": {
                    "registered": false,
                    "photo": null,
                    "last_seen": null
                },
                "viber": {
                    "registered": false,
                    "photo": null,
                    "last_seen": null
                }
            }
        }
    },
    "transaction_id": "{{transaction_id}}",
    "request_id": "{{request_id}}"
}