# Getting started

<figure><img src="https://2927352434-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyAmEVMxhOOdXgxn7sjnz%2Fuploads%2FcguKqDPURwT3t5qFdirr%2FFrame%2062.png?alt=media&#x26;token=9614c57c-a3e3-4139-876d-db6c34fea948" alt=""><figcaption></figcaption></figure>

We've designed our API to be fast and simple to integrate, allowing you to create applicants and retrieve results easily. We offer no, low and full-code integration options. Head to the next page to select how you'd like to integrate.

When interacting, the API requires parameters to be passed in valid JSON format and responds with a JSON payload. In our examples, we use the Content-Type `multipart/form-data`, but `application/json` is also supported.

Host URL: <https://enterprise.personr.co/api/1.1/wf/>

As we continually improve the platform, from time-to-time we include additional data within endpoint responses. When developing with our API, make sure your platform, service, or code can account for these additions. We will never change endpoint URLs, response structures, or key-value pairs without letting you know in advance.

To get started, you'll need an active or subscribed Personr account.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://manual.personr.co/api-documentation/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
