Update an 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.

Parameters

---

answers

object[]

A list of the answers for the auth session's security questions

Required

---

answers[].question_id

string

The ID of the security question.

Required

---

answers[].answer_id

string

The ID of the selected answer corresponding to the security question.

Required

---

Returns

---

Returns an object with a list of additional security questions (if necessary, otherwise an empty list), and the authenticated field indicating whether or not the entity's identity was successfully verified.

cURL

PUT /entities/:entity_id/auth_session

curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8/auth_session \
  -X PUT \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "answers": [
      {
        "question_id": "qtn_ywWqCnXDGGmmg",
        "answer_id": "ans_74H68MJjqNhk8"
      },
      ...
    ]
  }'

Node.js

PUT /entities/:entity_id/auth_session

const response = await method.entities.updateAuthSession('ent_au22b1fbFJbp8', {
  answers: [
    {
      "question_id": "qtn_ywWqCnXDGGmmg",
      "answer_id": "ans_74H68MJjqNhk8"
    },
    ...
  ]
});

Python

PUT /entities/:entity_id/auth_session

response = method.entities.update_auth_session('ent_au22b1fbFJbp8', {
  "answers": [
    {
      "question_id": "qtn_ywWqCnXDGGmmg",
      "answer_id": "ans_74H68MJjqNhk8"
    },
    ...
  ]
})

RESPONSE

{
  "questions": [],
  "authenticated": true
}