> For the complete documentation index, see [llms.txt](https://docs.parqex.com/-MUyxAVrX9S4wky8UoX6/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parqex.com/-MUyxAVrX9S4wky8UoX6/getting-started/requesting-an-account.md).

# Requesting an Account

Before you can attempt to make an authenticated request, you must first register your application with the ParqEx service by emailing ParqEx Support at <support@parqex.com>. ParqEx will then generate an account and return the credentials (a `client_id` and `client_secret`) to the **developer's contact email**.

You must supply ParqEx with the following:

* Developer Contact Information
  * Name
  * Email address
* Company/Product Name (eg. Google)
* Company/Product Website URL (eg. <https://google.com>)
* Application Name (can be same as company/product name)
* Description of Application (can be same as company/product desc.)
* Website URL of Application (if different than Website URL)
* Your Redirect/Callback URL for OAuth (e.g. <https://mysaasproduct.com/oauth/v1/authorize>)&#x20;

{% hint style="info" %}
**A Note about Mulitple Environments** - Most applications have multiple environments (eg. development, certification, production, etc.). If your application has more than one environment, you must supply the additional information for each environment as separate credentials will need to be created for each. Supply the following for each different environment:

* URL for application (eg. qa.example.com)
* Redirect/callback URL for OAuth
  {% endhint %}

### Example Request Email

Please use the following format to compose the email and send it to <support@parqex.com>:

> Dear Support,&#x20;
>
> I am requesting OAuth credentials for the below application.&#x20;
>
> **Name of Developer Contact:** John Doe\
> **Email Address of Developer Contact:** <john@myhomeapp.com>\
> **Name of Company/Product:** MyHome Inc.\
> **Website Address of Company/Product:** <https://myhomeapp.com>\
> **Name of Application:** MyHome\
> **Description of Application:**\
> MyHome allows users to monitor who is home and send notifications when someone leaves or returns.
>
> MyHome has two environments, DEV and PROD.
>
> For DEV:
>
> **Website Address of the Application:** <https://dev.myhomeapp.com>\
> **Redirect or Callback OAuth URL:** <https://dev.myhomeapp.com/oauth/v1/authorize>
>
> For PROD:
>
> **Website Address of the Application:** <https://myhomeapp.com>\
> **Redirect or Callback OAuth URL:** <https://myhomeapp.com/oauth/v1/authorize>

{% hint style="info" %}
**Note:** The Redirect URL (or Callback URL) is the endpoint Beam will redirect the user after they authorize (or deny) your application.
{% endhint %}

{% hint style="info" %}
**Important:** The OAuth redirect/callback URL **must start with `https://`**. Insecure URLs will not be accepted
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.parqex.com/-MUyxAVrX9S4wky8UoX6/getting-started/requesting-an-account.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.