Generate authentication token

Creates a programmatic authentication token for a verified, active external integrator. The token is emailed to the account address and is not returned by this request; the response contains the new session ID.

An integrator can have up to five active programmatic sessions. If a webhook URL is configured, OneLiquidity also sends a token-generated event containing the session ID, not the token.

IP allowlisting: Requests made with ReadMe's Try It feature are proxied through ReadMe, so they use ReadMe's current outbound IPs instead of your computer's public IP. Allow those addresses when testing through ReadMe, or allow your own outbound IP when running the generated request locally. For a temporary sandbox-only test, * can be used by itself; production rejects the wildcard.

Body Params

Token owner, allowed request sources, and expiry.

string
required

Email address of an existing, verified, active external integrator account. The generated token is delivered to this address.

whitelistedIps
array of strings, unique
required
length ≥ 1

Valid, unique IPv4 or IPv6 addresses permitted to use the token. The sandbox-only * wildcard must be the sole item and is rejected in production. For ReadMe Try It, use ReadMe's current outbound IPs rather than your local public IP.

whitelistedIps*
string
required

Use 1D, 7D, 30D, 60D, or a future YYYY-MM-DD date no more than one year away.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json