# Authentiq Connect API API

> Authentiq Connect API API on Apizie: 9 endpoints (Authenticate a user, List clients, Register a client, View a client, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/security:authentiq/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:authentiq`
- Category: Security
- Status: byok
- Source: https://www.authentiq.com/
- Page: https://www.apizie.tech/api/security/authentiq
- OpenAPI: https://www.apizie.tech/api/security/authentiq/openapi.json

Authentiq Connect OAuth 2.0 and OpenID Connect API reference. Learn about [Authentiq ID](https://www.authentiq.com/) or check out the [Authentiq Connect](https://developers.authentiq.com) developer documentation.

## Endpoints

### Authenticate a user
`GET https://www.apizie.tech/v1/security:authentiq/authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | yes | A client ID obtained from the [Dashboard](https://dashboard.authentiq.com/). |
| response_type | string | yes | The OIDC response type to use for this authentication flow. Valid choices are `code`, `id_token`, `token`, `token id_token`, `code… |
| scope | string | yes | The space-separated identity claims to request from the end-user. Always include `openid` as a scope for compatibility with OIDC. |
| redirect_uri | string | yes | The location to redirect to after (un)successful authentication. See OIDC for the parameters passed in the query string… |
| state | string | yes | An opaque string that will be passed back to the redirect URL and therefore can be used to communicate client side state and prevent CSRF… |
| response_mode | string | no | Whether to append parameters to the redirect URL in the query string (`query`) or as fragments (`fragment`). This option usually has a… |
| nonce | string | no | An nonce provided by the client (and opaque to Authentiq Connect) that will be included in any ID Token generated for this session.… |
| display | string | no | The authentication display mode, which can be one of `page`, `popup` or `modal`. Defaults to `page`. |
| prompt | string | no | Space-delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for… |
| max_age | integer | no | Specifies the allowable elapsed time in seconds since the last time the end-user was actively authenticated. |
| ui_locales | string | no | Specifies the preferred language to use on the authorization page, as a space-separated list of BCP47 language tags. Ignored at the moment. |

### List clients
`GET https://www.apizie.tech/v1/security:authentiq/client` (byok)

### Register a client
`POST https://www.apizie.tech/v1/security:authentiq/create-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### View a client
`GET https://www.apizie.tech/v1/security:authentiq/get-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | yes | Client identifier |

### Update a client
`POST https://www.apizie.tech/v1/security:authentiq/update-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | yes | Client identifier |
| body | object | yes | JSON request body |

### Delete a client
`POST https://www.apizie.tech/v1/security:authentiq/client-client-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | yes | Client identifier |

### Obtain an ID Token
`POST https://www.apizie.tech/v1/security:authentiq/token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Retrieve a user profile
`GET https://www.apizie.tech/v1/security:authentiq/user-info` (byok)

### Include a session iframe
`GET https://www.apizie.tech/v1/security:authentiq/authorize-iframe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | yes | Client identifier |

## Example
```
curl "https://www.apizie.tech/v1/security:authentiq/authorize" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Authentiq Connect API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/security:authentiq/authorize with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Authentiq Connect API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Authentiq Connect API itself also needs your own key from authentiq.io.

### Can AI agents use the Authentiq Connect API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:authentiq.

### What is the status of the Authentiq Connect API API?
Needs your own provider key (bring your own key)