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

# The preauth signals endpoint

export const preauth_name = "PreauthSignals";

export const get_common_parameters = (resource_name = 'resource') => {
  return {
    id: {
      name: 'id',
      type: "string",
      required: false,
      description: `Unique identifier for the ${resource_name}.`
    },
    entity_id: {
      name: 'entity_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Entity.'
    },
    account_id: {
      name: 'account_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Account.'
    },
    error: {
      name: 'error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href={`/reference/errors/${resource_name.replace(/^([A-Z])/, function (match) {
        return match.toLowerCase();
      }).replace(/([A-Z])/g, function (match) {
        return "-" + match.toLowerCase();
      })}-errors`}>{resource_name} errors</a>.
        </>
    },
    status_error: {
      name: 'status_error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href="/reference/errors/product-errors#status-errors">{resource_name} errors</a>.
        </>
    },
    metadata: {
      name: 'metadata',
      type: 'object | null',
      required: false,
      description: <>
          Additional data provided during creation.
          See <a href="/reference/metadata">metadata</a>
        </>
    },
    created_at: {
      name: 'created_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was created.`
    },
    updated_at: {
      name: 'updated_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was last updated.`
    },
    status: (enums = []) => ({
      name: 'status',
      type: 'enum',
      required: false,
      description: `Status of the ${resource_name}.`,
      enums
    }),
    type: (enums = []) => ({
      name: 'type',
      type: 'enum',
      required: false,
      description: `The type of ${resource_name}.`,
      enums
    })
  };
};

export const ParamList = ({items = [], is_child = false}) => {
  return items.map(item => {
    const field_props = {
      id: Math.random().toString(),
      body: item.name,
      name: item.name,
      type: item.type,
      required: item.required
    };
    const enums = item.enums || [];
    const items = item.items || [];
    const has_items = items?.length > 0;
    const has_enums = enums?.length > 0;
    const should_default_open = item.defaultOpen || false;
    const render_child_item = () => {
      const child_props = {
        title: has_enums ? "Possible enum values" : "properties"
      };
      if (should_default_open) child_props.defaultOpen = true;
      const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
        const is_last = idx === enums.length - 1;
        const is_2nd_to_last = idx === enums.length - 2;
        return <>
            <code>{enum_item}</code>
            {is_last && ''}
            {is_2nd_to_last && ' or '}
            {!is_last && !is_2nd_to_last && ', '}
          </>;
      });
      const enum_list = has_enums && !has_inline_enums && <Accordion {...child_props}>
          {enums.map((enum_item, index) => <div key={`enum-${index}`}>
              <code>{enum_item.name}</code>
              <br />
              <p>{enum_item.description}</p>
            </div>)}
        </Accordion>;
      const item_list = has_items && <Expandable {...child_props}>
          <ParamList items={items || []} is_child />
        </Expandable>;
      return <>
          <p>
            {item.description}
            {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
          </p>

          {enum_list}
          {item_list}
        </>;
    };
    return is_child ? <ResponseField {...field_props}>{render_child_item()}</ResponseField> : <ParamField {...field_props}>{render_child_item()}</ParamField>;
  });
};

The PreauthSignals endpoint returns the predicted likelihood that a transaction
will succeed for a connected credit card Account, alongside the card's standing and
recommended timing for the transaction.

<Note>
  **Public preview.** PreauthSignals is in public preview. Contact your Method CSM to request access.
</Note>

## Account requirements

PreauthSignals accepts a Method Account ID in the request path for a liability-backed credit card Account.
The Account must not be disabled and its consent must not be withdrawn. Closed Accounts
are supported and return a completed assessment with `success_likelihood: 0`.

The assessment is synchronous. `POST /accounts/{acc_id}/preauth` returns the completed or failed
PreauthSignals object after processing finishes.

<Note>
  PreauthSignals is available only with API version `2026-03-30`.
</Note>

**The PreauthSignals endpoint is available as a:**

| Type | Use-Case |
| - | - |
| `Product` | On-demand assessment of a transaction attempt for a connected credit card Account. |

## PreauthSignals Object

<ParamList
  items={[
(get_common_parameters(preauth_name).id),
{
name: 'account_id',
type: 'string',
required: true,
description: 'The ID of the credit card Account assessed by this request.',
},
(get_common_parameters(preauth_name).status(
[
  { name: 'completed', description: 'The request has successfully processed.' },
  { name: 'failed', description: 'The assessment could not be completed because its underlying liability was not found.' }
]
)),
{
name: 'verified_ownership',
type: 'enum | null',
required: false,
description: 'Whether the Account was resolved to its underlying credit card liability.',
enums: ['match']
},
{
name: 'card_standing',
type: 'enum | null',
required: false,
description: 'Standing derived from the connected credit card Account and its underlying liability.',
enums: ['active', 'closed']
},
{
name: 'success_likelihood',
type: 'number | null',
required: false,
description: 'The predicted probability that a charge will succeed under the provided conditions. Decimal 0.00 to 1.00.',
},
{
name: 'optimal_retry_date',
type: 'string | null',
required: false,
description: 'The recommended date to attempt or retry the charge. ISO 8601 date.',
},
{
name: 'error',
type: 'object | null',
required: false,
description: 'An error encountered while computing the assessment. May be populated on completed assessments when there is insufficient data to calculate predictive fields.',
},
(get_common_parameters(preauth_name).metadata),
(get_common_parameters(preauth_name).created_at),
(get_common_parameters(preauth_name).updated_at),
]}
/>

<ResponseExample>
  ```json The PreauthSignals Object theme={null}
  {
    "id": "preauth_qV7kRaFm4JNxw",
    "account_id": "acc_4m9amk4KFiaQX",
    "status": "completed",
    "verified_ownership": "match",
    "card_standing": "active",
    "success_likelihood": 0.82,
    "optimal_retry_date": "2026-05-28",
    "error": null,
    "metadata": null,
    "created_at": "2026-05-28T14:00:00.000Z",
    "updated_at": "2026-05-28T14:00:00.180Z"
  }
  ```
</ResponseExample>

## Insufficient data

When Method cannot compute a prediction from sufficiently recent liability data, the
assessment still returns `status: "completed"`. In that case, `success_likelihood` and
`optimal_retry_date` are `null`, and `error.sub_type` is `PREAUTH_INSUFFICIENT_DATA`.

If the Account's underlying liability cannot be found, the assessment returns
`status: "failed"` with `error.sub_type: "PREAUTH_FAILED_LIABILITY_NOT_FOUND"`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.