Create an individual auth session

Creates a new auth session for an entity to automatically retrieve their debt accounts.

---

⚠️ Caution: This endpoint is only accessible to entities that have the data:retrieve capability in available_capabilities.

ℹ️ Info: If your organization is enrolled in Method's non-KBA authentication, no questions will be returned.

Parameters

---

No parameters

Returns

---

Returns an object containing a list of security questions required to verify an entity's identity.

cURL

POST /entities/:entity_id/auth_session

curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8/auth_session \
  -X POST \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

POST /entities/:entity_id/auth_session

const response = await method.entities.createAuthSession('ent_au22b1fbFJbp8');

Python

POST /entities/:entity_id/auth_session

response = method.entities.create_auth_session('ent_au22b1fbFJbp8')

RESPONSE

{
  "questions": [
    {
      "id": "qtn_ywWqCnXDGGmmg",
      "text": "What is the monthly payment of your most recent auto loan or lease?",
      "answers": [
        {
          "id": "ans_qHLLEUBVpSpTK",
          "text": "$601 - $700"
        },
        {
          "id": "ans_b3xLiwTS8ygMy",
          "text": "$701 - $800"
        },
        {
          "id": "ans_Z5mMMLFy6waMK",
          "text": "$801 - $900"
        },
        {
          "id": "ans_BeSaN5Vj6tRjh",
          "text": "$901 - $1000"
        },
        {
          "id": "ans_74H68MJjqNhk8",
          "text": "None of the Above"
        }
      ]
    }
  ],
  "authenticated": false
}