Prembly API Documentation

This is the complete API documentation for connecting to the Prembly API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Prembly: Identity verification, fraud prevention, and background-check APIs for emerging markets. Keep reading to get started.

Quickstart

Before you run your first Prembly request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Prembly connection — create or choose one in Connections. Note its connectionId.

Every Prembly action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/prembly/latest/actions/{actionSlug}

You need a MindCloud API Key and a Prembly connection. Then call an action such as Get Bulk Fraud Scan Details:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/prembly/latest/actions/get-bulk-fraud-scan-details" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Prembly account that should run the action. MindCloud stores and refreshes the Prembly credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Prembly actions

All 40 published actions for this Prembly version. Each page documents the endpoint, arguments, and response controls.

• POSTAccount with Name Comparism
• POSTAddress Verification
• POSTAdvance Phone Number
• POSTBank Account (Basic)
• POSTBasic Phone Number
• POSTCompany Search By Person
• POSTCompany Search With Registration Number
• POSTCreate Candidate Request
• POSTCreate Custom Package
• DELETEDelete Custom Package
• POSTDocument Verification
• POSTDocument Verification with Face
• POSTFace Comparison
• POSTFace Liveliness Check
• POSTFace Scan
• POSTGeo-location
• GETGet Bulk Fraud Scan Details
• GETGet Candidate Request Detail
• GETGet Custom Package Detail
• GETGet Fraud Report Detail
• GETGet SDK Session
• GETGet System Package Detail
• GETGet Verification Status
• GETGet Wallet Balance
• POSTID Scan
• GETList All Check Types
• GETList Bulk Scan
• GETList Candidate Requests
• GETList Check Types by Country
• GETList Countries
• GETList Custom Packages
• GETList Fraud Reports
• GETList System Packages
• POSTPEP and Sanction
• PUTReinitiate Candidate Request
• POSTSubmit Fraud Report
• POSTTax Identification Number Check
• POSTTransaction Monitoring Screen Transaction
• PUTUpdate Custom Package
• POSTVIN/CAR CHASIS

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo