v1.0
OAS 3.1.0

Core API

The Core API provides a set of endpoints for managing accounts, subscriptions, team members, issuers and other resources in AuthPI.

Authentication

All endpoints require authentication. You can authenticate using an API token, which you can generate in your dashboard. Never directly expose your API token to the public. Instead, use a server-to-server flow. If you need to log the token identifier, you can extract it from the token itself using the kid claim.

Support

If you have any questions or need help, please contact us at [email protected].

Server: https://api.authpi.com/v1

Production server

Client Libraries

Account

List Accounts

List all accounts of the authenticated user

Responses
Request Example forGET/v1/accounts
curl https://api.authpi.com/v1/v1/accounts \
  --header 'Authorization: Basic username:password'
{
  "data": [
    {
      "id": "…",
      "issuer_id": "…",
      "name": null,
      "description": {
        "content_type": "plain",
        "value": "…"
      },
      "logo_url": "https://example.com",
      "org_type": "business",
      "settings": {
        "max_members": 1,
        "invitation": {
          "enabled": true,
          "display_name": "…",
          "description": {
            "content_type": "plain",
            "value": "…"
          },
          "website_url": "https://example.com"
        },
        "enforce_2fa": true
      },
      "stats": {
        "n_members": 1
      },
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "scopes": [
        "…"
      ],
      "contact": {
        "email": "[email protected]",
        "phone": "…",
        "website_url": "https://example.com"
      },
      "address": {
        "line1": "…",
        "line2": "…",
        "city": "…",
        "state": "…",
        "postal_code": "…",
        "country": "…"
      },
      "business_details": {
        "company_number": "…",
        "sector": "…",
        "tax_id": "…",
        "vat_number": "…",
        "charity_number": "…",
        "legal_name": "…",
        "legal_form": "…",
        "registration_date": "…",
        "registration_country": "…",
        "registration_state": "…",
        "registered_address": {
          "line1": "…",
          "line2": "…",
          "city": "…",
          "state": "…",
          "postal_code": "…",
          "country": "…"
        }
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "…"
      },
      "created_at": 1,
      "updated_at": 1,
      "feature_flags": [
        "…"
      ]
    }
  ]
}

Models