Quick Start - Venly Finance

Venly Finance offers two separate products — Fundflow API for multi-rail payment orchestration, and Finance API for embedded financial infrastructure. Both use OAuth2 client credentials for authentication.

Step 1 — Get your credentials

Your Client ID and Client Secret are provisioned by Venly and sent to you directly. If you haven’t received them, contact us.

Use your staging credentials while testing. Staging calls do not move real funds.

Step 2 — Get an access token

Exchange your credentials for a short-lived Bearer token:

curl -X POST https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

const response = await fetch(
  'https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token',
  {
    method: 'POST',
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    body: new URLSearchParams({
      grant_type: 'client_credentials',
      client_id: 'YOUR_CLIENT_ID',
      client_secret: 'YOUR_CLIENT_SECRET',
    }),
  }
);
const { access_token } = await response.json();

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...<redacted>",
  "expires_in": 300,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "not-before-policy": 0,
  "scope": "email profile"
}

Tokens expire after 5 minutes (300 seconds). Implement token refresh logic in your client so requests don’t fail mid-session.

Copy the access_token — you’ll pass it as a Bearer token in every subsequent request.

Step 3 — First Fundflow API call

Call GET /v1/company to confirm your Fundflow credentials are working and check your KYB verification status:

curl -X GET https://api-fundflow-staging.venly.io/v1/company \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

const response = await fetch('https://api-fundflow-staging.venly.io/v1/company', {
  headers: {
    'Authorization': `Bearer ${access_token}`,
    'Content-Type': 'application/json',
  },
});
const data = await response.json();

A successful response:

{
  "result": {
    "id": "b7e2c1a3-4d5f-6e7a-8b9c-0d1e2f3a4b5c",
    "name": "Your Company",
    "kybStatus": "VERIFIED"
  },
  "success": true
}

kybStatus: VERIFIED means your company is approved to create ramp requests. If it shows PENDING, KYB review is still in progress — contact us.

Step 4 — First Finance API call

Call POST /v1/parties to create your first party — the foundational record that will hold accounts and wallets:

curl -X POST https://api-staging.venlyfinance.com/v1/parties \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "partyType": "INDIVIDUAL",
    "firstName": "Jane",
    "lastName": "Doe"
  }'

const response = await fetch('https://api-staging.venlyfinance.com/v1/parties', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${access_token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    partyType: 'INDIVIDUAL',
    firstName: 'Jane',
    lastName: 'Doe',
  }),
});
const data = await response.json();

A successful 201 response:

{
  "success": true,
  "result": {
    "id": "f3a2b1c4-8d9e-4f5a-b6c7-d8e9f0a1b2c3",
    "partyType": "INDIVIDUAL",
    "status": "ACTIVE",
    "firstName": "Jane",
    "lastName": "Doe",
    "createdAt": "2026-01-15T09:30:00",
    "updatedAt": "2026-01-15T09:30:00",
    "version": 0
  }
}

Save the returned id — you’ll use it to create an account and assign wallets in the next steps.

A party is created ACTIVE immediately — no verification step. The account you open under it, however, starts unverified and can’t move money until a Venly admin verifies it. See Account verification.

Next Steps

Finance API walkthrough

Create a party, open and verify an account, fund it, and send your first transfer

Fundflow API guide

Set up bank accounts, wallets, and create your first ramp request

Authentication

Token refresh, environment switching, and credential security

Fundflow API Reference

Ramp requests, wallets, fees, currencies, and more

Finance API Reference

Parties, accounts, wallets, transfers, and IBANs

​Step 1 — Get your credentials

​Step 2 — Get an access token

​Step 3 — First Fundflow API call

​Step 4 — First Finance API call

​Next Steps

Finance API walkthrough

Fundflow API guide

Authentication

Fundflow API Reference

Finance API Reference

Step 1 — Get your credentials

Step 2 — Get an access token

Step 3 — First Fundflow API call

Step 4 — First Finance API call

Next Steps