Create a client

curl --request POST \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "sms_invitation": true,
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/clients"

payload = {
    "external_id": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "phone": "<string>",
    "sms_invitation": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: '<string>',
    email: 'jsmith@example.com',
    name: '<string>',
    phone: '<string>',
    sms_invitation: true,
    metadata: {}
  })
};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_id' => '<string>',
    'email' => 'jsmith@example.com',
    'name' => '<string>',
    'phone' => '<string>',
    'sms_invitation' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/clients"

	payload := strings.NewReader("{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.ledgersyncappv2.com/v3/clients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
  "created_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

Clients

Create a client

Create a Client (your end-user) before linking any bank accounts. The only field we need is something to identify them — use external_id to join back to a user record in your system, plus optional email and name for display.

Set phone to store a contact number for the client. To also text the client a login invitation on creation, send sms_invitation: true together with a non-blank phone (a request with sms_invitation: true and no phone is rejected with 400). Note: if the SMS cannot be delivered (e.g. an unsubscribed or invalid number), the client is not created and the call fails — retry without sms_invitation to create the client regardless.

POST

clients

Create a client

curl --request POST \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "sms_invitation": true,
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/clients"

payload = {
    "external_id": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "phone": "<string>",
    "sms_invitation": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: '<string>',
    email: 'jsmith@example.com',
    name: '<string>',
    phone: '<string>',
    sms_invitation: true,
    metadata: {}
  })
};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_id' => '<string>',
    'email' => 'jsmith@example.com',
    'name' => '<string>',
    'phone' => '<string>',
    'sms_invitation' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/clients"

	payload := strings.NewReader("{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.ledgersyncappv2.com/v3/clients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"sms_invitation\": true,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
  "created_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Headers

Idempotency-Key

string

Reserved, not yet honored. The header is accepted and ignored today: nothing reads it, no response is replayed, and idempotency_conflict is never returned. Do not auto-retry a failed POST on the assumption that this protects you — a retried POST /clients or POST /clients/{id}/connections creates a duplicate. Send the header if you want to be ready for it; do not depend on it. The behavior described below is the intended contract for a future release.

Safe-retry key for POSTs. Send any unique string per logical request (a UUIDv4 is great). If the network drops and you retry with the same Idempotency-Key within 24 hours, you get the exact same response back instead of creating a duplicate.

Cached responses include failures (4xx and 5xx) too. If a call failed because of a bad input and you want to try again with the corrected input, use a fresh key — otherwise you'll keep getting the cached failure.

Maximum string length: 255

Example:

"6f1a8c50-3e9c-4d4a-b1f5-2c5b9a2f7d11"

Body

application/json

external_id

string | null

string<email> | null

name

string | null

phone

string | null

Contact phone number for the client. Required when sms_invitation is true.

sms_invitation

boolean | null

If true, texts the client a login invitation on creation. Requires a non-blank phone.

metadata

object

Show child attributes

Response

Client created. The returned id (e.g. cli_01HXYZ...) is what you'll pass to every connection and account call.

string

required

Example:

"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

created_at

string<date-time>

required

external_id

string | null

Integrator-supplied identifier; useful for joining to your own systems.

string<email> | null

name

string | null

phone

string | null

Contact phone number for the client.

metadata

object

Free-form key-value pairs for integrator use. Max 20 keys.

Show child attributes

updated_at

string<date-time>

Health

Clients

Connections

Settings

Institutions

Accounts

Transactions

Statements

Checks

Operations

Webhooks

ApiKeys

Sandbox

Metrics

PortalGating

Create a client

Authorizations

Headers

Body

Response