Overview

Comprehensive reference for integrating with Palenca’s API.

Endpoint and schema overview

Palenca’s API endpoints and schemas are listed below. If you are looking for reference information about client-side integrations on web or mobile, see the Widget docs.

Users

Creating and managing your users in Palenca.

• /users/create
• /users/get
• /users/delete
• /users/search

Accounts

Connecting and fetching the user’s platform accounts.

• /accounts/create
• /accounts/get
• users/:user_id/accounts

Information Retrieval

Retrieve the profile, employment, and earnings information from your user’s platform accounts.

• accounts/:account_id/profile
• accounts/:account_id/employment
• accounts/:account_id/earnings

API Access

To gain access to the Palenca API, create an account on the Palenca Console. Once you’ve completed the sign-up process and acknowledge our terms, we’ll provide you with a private_api_key via the Console.

API Protocols and Headers

The Palenca API uses POST requests to communicate and HTTP response codes to indicate status and errors. All responses come in JSON standard. The Palenca API is served over HTTPS TLS [v1.3+] to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported. Clients must use an up to date root certificate bundle as the only TLS verification path; certificate pinning should never be used. All requests must include a Content-Type header of application/json and the body, when needed, must follow the JSON standard.

Almost all Palenca API's endpoints require a private api key. The api key is sent the request header x-api-private.

API Host

https://sandbox.palenca.com/v1
https://api.palenca.com/v1

Palenca has two environments: Sandbox and Production. Users, once created, cannot be moved to another environment. The Sandbox environment supports only test logins. The production environment supports 2 live connections using real data in a trial mode, and requires a paid plan to proceed after that.

When you’re getting ready to launch into Production, request your account upgrade via the Console.

API status and incidents

API and platforms status are available at status.palenca.com.

Client libraries

See the Widget page for more information on Palenca’s client libraries.