Make your first API request - Plexe API Portal

Start here to authenticate and read the industry list. This first call does not create an application or send a customer notification.

Before you start

Obtain API credentials and the correct environment URL from Plexe. Keep credentials and tokens in your server-side integration. Use test accounts and test data in the demo environment.

The examples use the demo origin https://apidemo.plexe.co. Set BASE_URL to an origin without a trailing slash or /api; the routes below already include /api. Use the environment assigned to you when moving to production.

1. Log in

Create a local login.json containing your credentials. The values below are placeholders. Keep this file out of source control and remove it after use.

{
  "username": "YOUR_API_USERNAME",
  "password": "YOUR_API_PASSWORD"
}

The following commands use Bash-compatible shell syntax. In PowerShell, use curl.exe and adapt the environment-variable syntax.

BASE_URL='https://apidemo.plexe.co'
curl --request POST "$BASE_URL/api/Authenication/login" \
  --header 'Content-Type: application/json' \
  --data-binary @login.json

The spelling Authenication is part of the API route. If requiresTwoFactor is true, complete two-factor verification before using the token. A successful HTTP response alone does not mean that sign-in is complete.

2. Make an authenticated read

Set TOKEN to the returned bearer token using your local secret-handling mechanism, then call:

curl --request GET "$BASE_URL/api/Lookup/get-industries" \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Accept: application/json'

Expect HTTP 200 with a JSON array of industry objects. An empty array is still a valid response. A 401 means authentication was not accepted; check the environment, token and expiry before retrying.

3. Choose your next task

Create and process an application: carry customer, application and loan IDs through the workflow.
Upload documents: encode document bytes and supply metadata correctly.
Complete approval: company details, applicants, bank accounts and signatures.
Read loans and initiate withdrawals: balances, calculations and available confirmation routes.
Receive webhooks: register a receiver and verify delivery signatures.
Handle errors and pagination: parse responses and avoid duplicate operations.

Reference and examples

Use the API reference for every documented route, parameter and response. Swagger UI and Swagger JSON describe the API on the current website. Generated schema samples show structure; replace placeholders and follow the validation guide before sending requests.