Skip to main content
POST
/
opal
/
token
curl https://production.methodfi.com/opal/token \
  -X POST \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_id": "ent_fc92i43kc34",
    "mode": "identity_verification",
    "identity_verification": {
      "skip_pii": ["name", "dob", "address"]
    }
  }'

{
  "success": true,
  "data": {
    "token": "otkn_THpBacqVBBrDkfqUf9htjm4QWAEJLY9a",
    "valid_until": "2025-05-08T22:21:40.312Z",
    "session_id": "osess_zde3mW34pEHqV"
  },
  "message": null
}
Opal tokens are used as the starting point and authentication key to instantiate Method’s embeddable UI components within your experience.
For security purposes, Opal tokens are for one-time use only, and expire after 30 minutes.

Body

The structure of the request body differs slightly depending on the Opal mode you are trying to use. See the Opal Modes section for more information about specific modes.
Only entity_id or entity is required. If both are provided, entity_id will be ignored.

Mode parameters

  • Identity Verification
  • Connect
  • Card Connect
  • Account Verification
  • Transactions
curl https://production.methodfi.com/opal/token \
  -X POST \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_id": "ent_fc92i43kc34",
    "mode": "identity_verification",
    "identity_verification": {
      "skip_pii": ["name", "dob", "address"]
    }
  }'

{
  "success": true,
  "data": {
    "token": "otkn_THpBacqVBBrDkfqUf9htjm4QWAEJLY9a",
    "valid_until": "2025-05-08T22:21:40.312Z",
    "session_id": "osess_zde3mW34pEHqV"
  },
  "message": null
}