Clients

Create a client

POST /api/v1/clients

Adds a client to your institution, with the same checks as the dashboard form.

You need an institution key with the clients:read_write scope. Your administrator makes one in Settings › API access.

Parameters

name

string · required

The client’s name.

category

string · optional

Individual or Company.

email

string · optional

Contact email.

telephone

string · optional

Contact telephone, with country code.

address

string · optional

Postal or physical address.

tin

string · optional

Tax identification number.

401 invalid_key

The key is missing, unknown, revoked or expired.

403 ip_not_allowed

The request came from an address the key is not allowed to use.

429 rate_limited

Too many requests this minute. Wait for Retry-After seconds.

429 quota_exceeded

The monthly allowance is used up. It resets on the first of the month.

403 wrong_key

This is a comparables key. Use an institution key for this endpoint.

403 api_not_enabled

API access isn’t switched on for your institution.

403 not_in_plan

This API isn’t part of your institution’s plan. Ask ValueApps to add it.

403 insufficient_scope

The key doesn’t have the access this call needs.

422 validation_failed

A field is missing or not valid; details names it.