> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paraform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Base URL and versioning

> Where the API lives, request format, and how versions are expressed.

All endpoints live under one base URL:

```text theme={null}
https://external-api.paraform.com/api/external/v1
```

Paths in these docs, such as `GET /identity`, are relative to that base URL.

## Request and response format

* Requests and responses are JSON. Send `Content-Type: application/json` with every request that has a body.
* Files, such as resume PDFs, are sent as base64-encoded text inside the JSON body, not as multipart uploads. See [Upload a resume](/agency/api-reference/upload-resume).
* `GET` endpoints take their inputs as query parameters. To send several values for an array filter, repeat the parameter (for example `?location=new_york&location=boston`).
* Path parameters such as `{roleId}` are part of the URL. If a body or query field has the same name, the URL value wins.
* Request bodies are limited to 12 MB. A larger body is rejected with `413` before it reaches the API, so that response has neither the standard error envelope nor a request id.
* Every response carries an `X-Request-Id` header. Quote it when you contact Paraform about a specific request.
* Responses are never cached: every response is sent with `Cache-Control: private, no-store`.

## Versioning

The version is part of the path (`/v1`). Within a version, the API documents some stable vocabularies (for example batch `errorCode` values and market-status `status` values) as **never renamed, but extended**: new values may be added, so treat unknown values as described on each endpoint's page.

## Health check

`GET /health` needs no API key and returns `{"status": "ok", ...}` while the API is serving requests.

```bash theme={null}
curl "https://external-api.paraform.com/api/external/v1/health"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.