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

# Authmatech REST API — Overview, Base URL & Conventions

> The Authmatech REST API: base URL, authentication headers, the JSON response envelope, phone number format, and the endpoint groups you can call.

The Authmatech REST API gives you programmatic access to silent mobile identity verification and the identity-intelligence suite — Verify, Trust, Shield, Detect, and Target — from one consistent HTTP interface. (Stuck, Stuck+, and Connect are dashboard features and have no developer endpoints.) Every request travels over HTTPS, carries a JSON body, and returns a JSON response wrapped in a standard envelope.

## Base URL

```
https://service.authmatech.com
```

<Warning>
  Plain HTTP is not supported. All traffic must use HTTPS to protect your credentials and your customers' data in transit.
</Warning>

## Authentication

Every server-side request requires two headers:

```
X-API-KEY: YOUR_API_KEY
X-CLIENT-ID: YOUR_CLIENT_ID
```

The API key is a server-side secret. Browser and mobile SDK flows use a narrow-scoped `X-SDK-TOKEN` instead, which can only register sessions. See [Authentication](/api/authentication).

## Request format

Requests with a body must set `Content-Type: application/json` and send valid JSON.

```http theme={null}
Content-Type: application/json
```

## Response envelope

Every response — success or failure — uses the same shape:

```json theme={null}
{
  "success": true,
  "messages": [
    { "type": "SUCCESS", "code": null, "message": null, "httpStatus": "OK" }
  ],
  "data": { "validNumber": true }
}
```

Read your result from `data`. Treat `success: false` or a non‑`200` status as an error and surface `messages[].message`. Full details in [Errors & responses](/api/errors).

## Phone number format

All mobile numbers use **E.164** — a leading `+`, the country code (no leading zero), and the subscriber number, with no spaces, dashes, or parentheses.

| ✅ Valid         | ❌ Invalid          |
| --------------- | ------------------ |
| `+962791234567` | `0791234567`       |
| `+971501234567` | `+971 50 123 4567` |
| `+966512345678` | `+966-51-2345678`  |

<Tip>
  Libraries such as Google's libphonenumber (`libphonenumber-js`) convert local formats to E.164 before you send them.
</Tip>

## Endpoint groups

<CardGroup cols={2}>
  <Card title="Verify" icon="circle-check" href="/guides/verify">
    Confirm a customer controls their mobile number, silently.
  </Card>

  <Card title="Identity intelligence" icon="brain" href="/guides/trust-shield-detect">
    Trust score, Shield risk decisions, and Detect anomalies.
  </Card>

  <Card title="SDK & sessions" icon="mobile" href="/sdks/mobile">
    Register an SDK session from the native mobile SDK.
  </Card>

  <Card title="Target" icon="bullseye-arrow" href="/guides/target">
    Capture high-intent anonymous visitor opportunities.
  </Card>

  <Card title="Client portal" icon="user-gear" href="/guides/testing">
    Usage, verification history, and API-key management.
  </Card>
</CardGroup>

<Note>
  Administrative endpoints under `/v1/api/dashboard/**` power the Authmatech dashboard and are not part of the standard developer integration surface.
</Note>

## Support

Questions or issues? Email [connect@authmatech.com](mailto:connect@authmatech.com) (Sun–Thu, 09:00–18:00 Amman time).