> ## 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 sensitive endpoint

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 Sensitive endpoint returns underlying sensitive Account information (e.g. PAN, CVV, account number). This product is only available for Liabilities.

<Warning>The Sensitive endpoint is restricted to most teams, and requires PCI compliance to access. Contact your Method CSM for more information.</Warning>

## Sensitive Objects

<ParamList
  items={[
get_common_parameters("Sensitive").id,
get_common_parameters("Sensitive").account_id,
get_common_parameters("Sensitive").type([
  {
    name: "credit_card",
    description: "A credit card Sensitive object.",
  },
  {
    name: "mortgage",
    description: "A mortgage Sensitive object.",
  },
  {
    name: "auto_loan",
    description: "An auto loan Sensitive object.",
  },
  {
    name: "personal_loan",
    description: "A personal loan Sensitive object.",
  },
  {
    name: "collection",
    description: "A collection Sensitive object.",
  },
  {
    name: "student_loans",
    description: "A student loan Sensitive object.",
  },
  {
    name: "credit_builder",
    description: "A credit builder Sensitive object.",
  },
  {
    name: "bnpl",
    description: "A buy now, pay later Sensitive object.",
  },
  {
    name: "fintech",
    description: "A fintech Sensitive object.",
  },
  {
    name: "loan",
    description: "A loan Sensitive object.",
  },
]),
get_common_parameters("Sensitive").status([
  {
    name: "completed",
    description: "The Sensitive request successfully completed.",
  },
  {
    name: "failed",
    description: (
      <>
        The Sensitive request failed to complete. See{" "}
        <code>error</code> field.
      </>
    ),
  },
]),
get_common_parameters("Sensitive").error,
get_common_parameters("Sensitive").created_at,
get_common_parameters("Sensitive").updated_at,
]}
/>

## Additional Properties based on type

<Tabs>
  <Tab title="Credit Card">
    <ParamList
      items={[
    {
      name: "credit_card",
      type: "object | null",
      description: "The credit card sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "credit_card.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
        {
          name: "credit_card.exp_month",
          type: "string | null",
          description:
            "The expiration month of the card.",
        },
        {
          name: "credit_card.exp_year",
          type: "string | null",
          description:
            "The expiration year of the card.",
        },
        {
          name: "credit_card.cvv",
          type: "string | null",
          description:
            "The cvv of the card.",
        },
        {
          name: "credit_card.billing_zip_code",
          type: "string | null",
          description:
            "The billing zip code of the card.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Auto Loan">
    <ParamList
      items={[
      {
        name: "auto_loan",
        type: "object | null",
        description: "The auto loan sensitive object.",
        defaultOpen: true,
        items: [
          {
            name: "auto_loan.number",
            type: "string | null",
            description:
              "The full Account number.",
          },
        ],
      }
    ]}
    />
  </Tab>

  <Tab title="Mortgage">
    <ParamList
      items={[
    {
      name: "mortgage",
      type: "object | null",
      description: "The mortgage sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "mortgage.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Personal Loan">
    <ParamList
      items={[
    {
      name: "personal_loan",
      type: "object | null",
      description: "The personal loan sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "personal_loan.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Collection">
    <ParamList
      items={[
    {
      name: "collection",
      type: "object | null",
      description: "The collection sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "collection.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Student Loans">
    <ParamList
      items={[
    {
      name: "student_loans",
      type: "object | null",
      description: "The student loan sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "student_loans.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Credit Builder">
    <ParamList
      items={[
    {
      name: "credit_builder",
      type: "object | null",
      description: "The credit builder sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "credit_builder.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="BNPL">
    <ParamList
      items={[
    {
      name: "bnpl",
      type: "object | null",
      description: "The buy now, pay later sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "bnpl.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Fintech">
    <ParamList
      items={[
    {
      name: "fintech",
      type: "object | null",
      description: "The fintech sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "fintech.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>

  <Tab title="Loan">
    <ParamList
      items={[
    {
      name: "loan",
      type: "object | null",
      description: "The loan sensitive object.",
      defaultOpen: true,
      items: [
        {
          name: "loan.number",
          type: "string | null",
          description:
            "The full Account number.",
        },
      ],
    }
  ]}
    />
  </Tab>
</Tabs>

## Webhook Payload

The [Webhook](/2026-03-30/reference/webhooks/overview) payload will contain the following information:

```json theme={null}
{
  "id": "string",
  "type": "sensitive.create" | "sensitive.update",
  "path": "/accounts/<acc_id>/sensitive/<astv_id>",
}
```

<RequestExample>
  ```json Credit Card theme={null}
  {
    "id": "astv_9WBBA6TH7n7iX",
    "account_id": "acc_yVf3mkzbhz9tj",
    "type": "credit_card",
    "credit_card": {
      "number": "5555555555551580",
      "exp_month": "09",
      "exp_year": "2030",
      "cvv": "878",
      "billing_zip_code": null,
    },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.857Z",
    "updated_at": "2024-04-26T22:50:24.857Z",
  }
  ```

  ```json Auto Loan theme={null}
  {
    "id": "astv_BkdLEqDV4hyrR",
    "account_id": "acc_zcAbRXrEqVAFr",
    "type": "auto_loan",
    "auto_loan": { "number": "2719668732" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Mortgage theme={null}
  {
    "id": "astv_tB9mpmew8FLit",
    "account_id": "acc_RGACQH7XdfYhC",
    "type": "mortgage",
    "mortgage": { "number": "5123564678934" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Personal Loan theme={null}
  {
    "id": "astv_A8grUi7rzwi9g",
    "account_id": "acc_uHDiQGxiR8bqc",
    "type": "personal_loan",
    "personal_loan": { "number": "87234091345" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Collection theme={null}
  {
    "id": "astv_N8qBq4Xi6hnMn",
    "account_id": "acc_KgNMfWHcBtycK",
    "type": "collection",
    "collection": { "number": "304576234" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Student Loans theme={null}
  {
    "id": "astv_eL2oUu7v1qGw",
    "account_id": "acc_R5eT2YzGgQ4k",
    "type": "student_loans",
    "student_loans": { "number": "399745627183" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Credit Builder theme={null}
  {
    "id": "astv_k2SqV9Tp0xFc",
    "account_id": "acc_f9zN3vxr05sL",
    "type": "credit_builder",
    "credit_builder": { "number": "593874621059" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json BNPL theme={null}
  {
    "id": "astv_x8RqU2sm0zPd",
    "account_id": "acc_w4Lk2mBn90tE",
    "type": "bnpl",
    "bnpl": { "number": "287364519087" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Fintech theme={null}
  {
    "id": "astv_n3WqP7sl4vHy",
    "account_id": "acc_d6Pk1sQr84mX",
    "type": "fintech",
    "fintech": { "number": "540987312654" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```

  ```json Loan theme={null}
  {
    "id": "astv_b4HqT6vn2cWp",
    "account_id": "acc_t7Vm4zQc51dP",
    "type": "loan",
    "loan": { "number": "170298364517" },
    "status": "completed",
    "error": null,
    "created_at": "2024-04-26T22:50:24.724Z",
    "updated_at": "2024-04-26T22:50:24.724Z"
  }
  ```
</RequestExample>