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

# Addresses

> Users, businesses, and payment card funding sources in the Marqeta platform are associated with an address for billing purposes. List and manage these addresses here.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

The address resource is your billing address. An active address is required in order to use a payment card funding source. To associate an address with a funding source, use the same `user_token` or `business_token` for both resources.

<Note>
  **Note**\
  The `/users` and `/businesses` resources also have address fields. Those are used for other purposes, such as KYC identity verification or as shipping addresses for physical cards.
</Note>

<h2 id="post_fundingsources_addresses">
  Create address
</h2>

**Action:** `POST`\
**Endpoint:** `/fundingsources/addresses`

{/* <EndpointCard
title="Creates an account holder address for a funding source"
path="/fundingsources/addresses"
method="post"
/> */}

Use this endpoint to create an address resource.

When creating the address, you must pass the token of either an existing user in the `user_token` field or an existing business in the `business_token` field. Do not pass both.

<h3 id="_request_body">
  Request body
</h3>

| Fields                                                      | Description                                                                                                                                                                                                                                                                                                                                                           |
| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active<br /><br />boolean<br /><br />Optional               | Specifies whether the address is active.<br /><br />**Allowable Values:**<br /><br />`true`, `false`<br /><br />**Default value:**<br />`true`                                                                                                                                                                                                                        |
| address\_1<br /><br />string<br /><br />Required            | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                       |
| address\_2<br /><br />string<br /><br />Optional            | Additional address information.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                              |
| business\_token<br /><br />string<br /><br />Optional       | Unique identifier of the business account holder. This token is required if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                   |
| city<br /><br />string<br /><br />Required                  | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                          |
| country<br /><br />string<br /><br />Required               | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                                        |
| first\_name<br /><br />string<br /><br />Required           | First name or given name of the account holder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                               |
| is\_default\_address<br /><br />boolean<br /><br />Optional | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />**Allowable Values:**<br /><br />`true`, `false`<br /><br />**Default value:**<br />`false`                                  |
| last\_name<br /><br />string<br /><br />Required            | Last name or family name of the account holder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                               |
| phone<br /><br />string<br /><br />Optional                 | Telephone number of the account holder.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                      |
| postal\_code<br /><br />string<br /><br />Optional          | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                   |
| state<br /><br />string<br /><br />Required                 | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                                   |
| token<br /><br />string<br /><br />Optional                 | Unique identifier of the address. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.<br /><br />**Allowable Values:**<br /><br />1–36 chars |
| user\_token<br /><br />string<br /><br />Optional           | Unique identifier of the user account holder. This token is required if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                   |
| zip<br /><br />string<br /><br />Optional                   | United States ZIP code. This field is required if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                             |

<h3 id="_sample_request_body">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "my_funding_source_address_biz_01",
  "city": "Berkeley",
  "state": "CA",
  "postal_code": "94705",
  "zip": "94705",
  "country": "USA",
  "phone": "5104444444",
  "business_token": "my_business_01",
  "first_name": "Jane",
  "last_name": "Doe",
  "address_1": "1234 Grove Street"
}
```

<h3 id="_response_body">
  Response body
</h3>

| Fields                                                                    | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active<br /><br />boolean<br /><br />Conditionally returned               | Specifies whether the address is active.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                      |
| address\_1<br /><br />string<br /><br />Returned                          | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                           |
| address\_2<br /><br />string<br /><br />Conditionally returned            | Additional address information.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                  |
| business\_token<br /><br />string<br /><br />Conditionally returned       | Unique identifier of the business account holder. This token is returned if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| city<br /><br />string<br /><br />Returned                                | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                              |
| country<br /><br />string<br /><br />Returned                             | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                            |
| created\_time<br /><br />datetime<br /><br />Returned                     | Date and time when the resource was created, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                |
| first\_name<br /><br />string<br /><br />Returned                         | First or given name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                            |
| is\_default\_address<br /><br />boolean<br /><br />Conditionally returned | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |
| last\_modified\_time<br /><br />datetime<br /><br />Returned              | Date and time when the resource was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                          |
| last\_name<br /><br />string<br /><br />Returned                          | Last name or family name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                       |
| phone<br /><br />string<br /><br />Conditionally returned                 | Telephone number of the cardholder.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                              |
| postal\_code<br /><br />string<br /><br />Returned                        | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                       |
| state<br /><br />string<br /><br />Returned                               | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                       |
| token<br /><br />string<br /><br />Returned                               | Unique identifier of the address object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                           |
| user\_token<br /><br />string<br /><br />Conditionally returned           | Unique identifier of the user account holder. This token is returned if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| zip<br /><br />string<br /><br />Returned                                 | United States ZIP code of the address. This field is returned if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                  |

<h3 id="_sample_response_body">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "business_token": "my_business_01",
  "token": "my_funding_source_address_biz_01",
  "first_name": "Jane",
  "last_name": "Doe",
  "address_1": "1234 Grove Street",
  "city": "Berkeley",
  "state": "CA",
  "postal_code": "94705",
  "zip": "94705",
  "country": "USA",
  "phone": "5104444444",
  "is_default_address": true,
  "active": true,
  "created_time": "2023-02-20T20:04:13Z",
  "last_modified_time": "2023-02-20T20:04:13Z"
}
```

<h2 id="get_fundingsources_addresses_business_businesstoken">
  List business addresses
</h2>

**Action:** `GET`\
**Endpoint:** `/fundingsources/addresses/business/{business_token}`

{/* <EndpointCard
title="List all addresses for a business"
path="/fundingsources/addresses/business/{business_token}"
method="get"
/> */}

Use this endpoint to list existing addresses for a business. This endpoint supports [field filtering](/core-api/field-filtering/).

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                                | Description                                                                                                                                                                                                  |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| business\_token<br /><br />string<br /><br />Required | Unique identifier of the business account holder.<br /><br />Send a `GET` request to `/businesses` to retrieve business tokens.<br /><br />**Allowable Values:**<br /><br />Existing business resource token |

<h3 id="_url_query_parameters">
  URL query parameters
</h3>

| Fields                                       | Description                                                                                                                                                                                     |
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fields<br /><br />string<br /><br />Optional | Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields.<br /><br />**Allowable Values:**<br /><br />Comma-delimited list of fields, or blank |

<h3 id="_response_body_2">
  Response body
</h3>

| Fields                                                                                | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| count<br /><br />integer<br /><br />Conditionally returned                            | Number of resources to retrieve.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />1-10                                                                                                                                                                                        |
| data<br /><br />array of objects<br /><br />Conditionally returned                    | Array of address objects.<br /><br />Objects are returned as appropriate to your query.<br /><br />**Allowable Values:**<br /><br />Valid data array of one or more address objects                                                                                                                                                                       |
| data\[].**active**<br /><br />boolean<br /><br />Conditionally returned               | Specifies whether the address is active.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                      |
| data\[].**address\_1**<br /><br />string<br /><br />Returned                          | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                           |
| data\[].**address\_2**<br /><br />string<br /><br />Conditionally returned            | Additional address information.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                  |
| data\[].**business\_token**<br /><br />string<br /><br />Conditionally returned       | Unique identifier of the business account holder. This token is returned if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| data\[].**city**<br /><br />string<br /><br />Returned                                | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                              |
| data\[].**country**<br /><br />string<br /><br />Returned                             | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                            |
| data\[].**created\_time**<br /><br />datetime<br /><br />Returned                     | Date and time when the resource was created, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                |
| data\[].**first\_name**<br /><br />string<br /><br />Returned                         | First or given name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                            |
| data\[].**is\_default\_address**<br /><br />boolean<br /><br />Conditionally returned | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |
| data\[].**last\_modified\_time**<br /><br />datetime<br /><br />Returned              | Date and time when the resource was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                          |
| data\[].**last\_name**<br /><br />string<br /><br />Returned                          | Last name or family name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                       |
| data\[].**phone**<br /><br />string<br /><br />Conditionally returned                 | Telephone number of the cardholder.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                              |
| data\[].**postal\_code**<br /><br />string<br /><br />Returned                        | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                       |
| data\[].**state**<br /><br />string<br /><br />Returned                               | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                       |
| data\[].**token**<br /><br />string<br /><br />Returned                               | Unique identifier of the address object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                           |
| data\[].**user\_token**<br /><br />string<br /><br />Conditionally returned           | Unique identifier of the user account holder. This token is returned if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| data\[].**zip**<br /><br />string<br /><br />Returned                                 | United States ZIP code of the address. This field is returned if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                  |
| end\_index<br /><br />integer<br /><br />Conditionally returned                       | Sort order index of the last resource in the returned array.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                     |
| is\_more<br /><br />boolean<br /><br />Conditionally returned                         | A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                      |
| start\_index<br /><br />integer<br /><br />Conditionally returned                     | Sort order index of the first resource in the returned array.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                    |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "count": 2,
  "start_index": 0,
  "end_index": 1,
  "is_more": false,
  "data": [
    {
      "business_token": "my_business_01",
      "token": "my_funding_source_address_bus_01",
      "first_name": "Jane",
      "last_name": "Doe",
      "address_1": "1234 Grove Street",
      "city": "Berkeley",
      "state": "CA",
      "postal_code": "94705",
      "zip": "94705",
      "country": "USA",
      "phone": "5104444444",
      "is_default_address": true,
      "active": true,
      "created_time": "2023-02-26T21:34:42Z",
      "last_modified_time": "2023-02-27T18:55:59Z"
    },
    {
      "business_token": "my_business_01",
      "token": "my_funding_source_address_bus_02",
      "first_name": "Jane",
      "last_name": "Doe",
      "address_1": "5678 Grove Street",
      "city": "Berkeley",
      "state": "CA",
      "postal_code": "94705",
      "zip": "94705",
      "country": "USA",
      "phone": "5104444444",
      "is_default_address": false,
      "active": true,
      "created_time": "2023-02-25T19:48:30Z",
      "last_modified_time": "2023-03-25T10:17:38Z"
    }
  ]
}
```

<h2 id="get_fundingsources_addresses_user_usertoken">
  Lists all addresses for a user
</h2>

**Action:** `GET`\
**Endpoint:** `/fundingsources/addresses/user/{user_token}`

{/* <EndpointCard
title="List all addresses for a user"
path="/fundingsources/addresses/user/{user_token}"
method="get"
/> */}

Use this endpoint to list existing addresses for a user. This endpoint supports [field filtering](/core-api/field-filtering/).

<h3 id="_url_path_parameters_2">
  URL path parameters
</h3>

| Fields                                            | Description                                                                                                            |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| user\_token<br /><br />string<br /><br />Required | Unique identifier of the user account holder.<br /><br />**Allowable Values:**<br /><br />Existing user resource token |

<h3 id="_url_query_parameters_2">
  URL query parameters
</h3>

| Fields                                       | Description                                                                                                                                                                                     |
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fields<br /><br />string<br /><br />Optional | Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields.<br /><br />**Allowable Values:**<br /><br />Comma-delimited list of fields, or blank |

<h3 id="_response_body_3">
  Response body
</h3>

| Fields                                                                                | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| count<br /><br />integer<br /><br />Conditionally returned                            | Number of resources to retrieve.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />1-10                                                                                                                                                                                        |
| data<br /><br />array of objects<br /><br />Conditionally returned                    | Array of address objects.<br /><br />Objects are returned as appropriate to your query.<br /><br />**Allowable Values:**<br /><br />Valid data array of one or more address objects                                                                                                                                                                       |
| data\[].**active**<br /><br />boolean<br /><br />Conditionally returned               | Specifies whether the address is active.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                      |
| data\[].**address\_1**<br /><br />string<br /><br />Returned                          | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                           |
| data\[].**address\_2**<br /><br />string<br /><br />Conditionally returned            | Additional address information.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                  |
| data\[].**business\_token**<br /><br />string<br /><br />Conditionally returned       | Unique identifier of the business account holder. This token is returned if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| data\[].**city**<br /><br />string<br /><br />Returned                                | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                              |
| data\[].**country**<br /><br />string<br /><br />Returned                             | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                            |
| data\[].**created\_time**<br /><br />datetime<br /><br />Returned                     | Date and time when the resource was created, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                |
| data\[].**first\_name**<br /><br />string<br /><br />Returned                         | First or given name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                            |
| data\[].**is\_default\_address**<br /><br />boolean<br /><br />Conditionally returned | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |
| data\[].**last\_modified\_time**<br /><br />datetime<br /><br />Returned              | Date and time when the resource was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                          |
| data\[].**last\_name**<br /><br />string<br /><br />Returned                          | Last name or family name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                       |
| data\[].**phone**<br /><br />string<br /><br />Conditionally returned                 | Telephone number of the cardholder.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                              |
| data\[].**postal\_code**<br /><br />string<br /><br />Returned                        | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                       |
| data\[].**state**<br /><br />string<br /><br />Returned                               | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                       |
| data\[].**token**<br /><br />string<br /><br />Returned                               | Unique identifier of the address object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                           |
| data\[].**user\_token**<br /><br />string<br /><br />Conditionally returned           | Unique identifier of the user account holder. This token is returned if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| data\[].**zip**<br /><br />string<br /><br />Returned                                 | United States ZIP code of the address. This field is returned if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                  |
| end\_index<br /><br />integer<br /><br />Conditionally returned                       | Sort order index of the last resource in the returned array.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                     |
| is\_more<br /><br />boolean<br /><br />Conditionally returned                         | A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                      |
| start\_index<br /><br />integer<br /><br />Conditionally returned                     | Sort order index of the first resource in the returned array.<br /><br />This field is returned if there are resources in your returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                    |

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "count": 2,
  "start_index": 0,
  "end_index": 1,
  "is_more": false,
  "data": [
    {
      "business_token": "my_user_01",
      "token": "my_funding_source_address_user_01",
      "first_name": "Jane",
      "last_name": "Doe",
      "address_1": "1234 Grove Street",
      "city": "Berkeley",
      "state": "CA",
      "postal_code": "94705",
      "zip": "94705",
      "country": "USA",
      "phone": "5104444444",
      "is_default_address": true,
      "active": true,
      "created_time": "2023-02-27T21:34:42Z",
      "last_modified_time": "2023-02-28T18:55:59Z"
    },
    {
      "business_token": "my_user_01",
      "token": "my_funding_source_address_user_02",
      "first_name": "Jane",
      "last_name": "Doe",
      "address_1": "5678 Grove Street",
      "city": "Berkeley",
      "state": "CA",
      "postal_code": "94705",
      "zip": "94705",
      "country": "USA",
      "phone": "5104444444",
      "is_default_address": false,
      "active": true,
      "created_time": "2023-02-25T19:48:30Z",
      "last_modified_time": "2023-03-25T19:48:30Z"
    }
  ]
}
```

<h2 id="get_fundingsources_addresses_fundingsourceaddresstoken">
  Retrieve address
</h2>

**Action:** `GET`\
**Endpoint:** `/fundingsources/addresses/{funding_source_address_token}`

{/* <EndpointCard
title="Returns a user address for a funding source"
path="/fundingsources/addresses/{funding_source_address_token}"
method="get"
/> */}

Use this endpoint to retrieve a funding source address.

<h3 id="_url_path_parameters_3">
  URL path parameters
</h3>

| Fields                                                                | Description                                                                                                                        |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| funding\_source\_address\_token<br /><br />string<br /><br />Required | Unique identifier of the funding source address.<br /><br />**Allowable Values:**<br /><br />Existing funding source address token |

<h3 id="_response_body_4">
  Response body
</h3>

| Fields                                                                    | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active<br /><br />boolean<br /><br />Conditionally returned               | Specifies whether the address is active.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                      |
| address\_1<br /><br />string<br /><br />Returned                          | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                           |
| address\_2<br /><br />string<br /><br />Conditionally returned            | Additional address information.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                  |
| business\_token<br /><br />string<br /><br />Conditionally returned       | Unique identifier of the business account holder. This token is returned if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| city<br /><br />string<br /><br />Returned                                | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                              |
| country<br /><br />string<br /><br />Returned                             | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                            |
| created\_time<br /><br />datetime<br /><br />Returned                     | Date and time when the resource was created, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                |
| first\_name<br /><br />string<br /><br />Returned                         | First or given name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                            |
| is\_default\_address<br /><br />boolean<br /><br />Conditionally returned | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |
| last\_modified\_time<br /><br />datetime<br /><br />Returned              | Date and time when the resource was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                          |
| last\_name<br /><br />string<br /><br />Returned                          | Last name or family name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                       |
| phone<br /><br />string<br /><br />Conditionally returned                 | Telephone number of the cardholder.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                              |
| postal\_code<br /><br />string<br /><br />Returned                        | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                       |
| state<br /><br />string<br /><br />Returned                               | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                       |
| token<br /><br />string<br /><br />Returned                               | Unique identifier of the address object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                           |
| user\_token<br /><br />string<br /><br />Conditionally returned           | Unique identifier of the user account holder. This token is returned if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| zip<br /><br />string<br /><br />Returned                                 | United States ZIP code of the address. This field is returned if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                  |

<h3 id="_sample_response_body_4">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "business_token": "my_business_01",
  "token": "my_funding_source_address_biz_01",
  "first_name": "Jane",
  "last_name": "Doe",
  "address_1": "1234 Grove Street",
  "city": "Berkeley",
  "state": "CA",
  "postal_code": "94705",
  "zip": "94705",
  "country": "USA",
  "phone": "5104444444",
  "is_default_address": true,
  "active": true,
  "created_time": "2023-02-20T20:04:13Z",
  "last_modified_time": "2023-02-20T20:04:13Z"
}
```

<h2 id="put_fundingsources_addresses_fundingsourceaddresstoken">
  Update address
</h2>

**Action:** `PUT`\
**Endpoint:** `/fundingsources/addresses/{funding_source_address_token}`

{/* <EndpointCard
title="Updates the account holder address for a funding source"
path="/fundingsources/addresses/{funding_source_address_token}"
method="put"
/> */}

Use this endpoint to update an address.

<h3 id="_url_path_parameters_4">
  URL path parameters
</h3>

| Fields                                                                | Description                                                                                                                        |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| funding\_source\_address\_token<br /><br />string<br /><br />Required | Unique identifier of the funding source address.<br /><br />**Allowable Values:**<br /><br />Existing funding source address token |

<h3 id="_request_body_2">
  Request body
</h3>

| Fields                                                      | Description                                                                                                                                                                                                                                                                                                                          |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| active<br /><br />boolean<br /><br />Optional               | Specifies whether the address is active.<br /><br />**Allowable Values:**<br /><br />`true`, `false`<br /><br />**Default value:**<br />`false`                                                                                                                                                                                      |
| address\_1<br /><br />string<br /><br />Optional            | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                      |
| address\_2<br /><br />string<br /><br />Optional            | Additional address information.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                             |
| city<br /><br />string<br /><br />Optional                  | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                         |
| country<br /><br />string<br /><br />Optional               | Country of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                      |
| first\_name<br /><br />string<br /><br />Optional           | First name or given name of the account holder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                              |
| is\_default\_address<br /><br />boolean<br /><br />Optional | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />**Allowable Values:**<br /><br />`true`, `false`<br /><br />**Default value:**<br />`false` |
| last\_name<br /><br />string<br /><br />Optional            | Last name or family name of the account holder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                              |
| phone<br /><br />string<br /><br />Optional                 | Telephone number of the account holder.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                     |
| postal\_code<br /><br />string<br /><br />Optional          | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                  |
| state<br /><br />string<br /><br />Optional                 | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max  |
| zip<br /><br />string<br /><br />Optional                   | United States ZIP code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                       |

<h3 id="_sample_request_body_2">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "address_1": "333 Elm Street"
}
```

<h3 id="_response_body_5">
  Response body
</h3>

| Fields                                                                    | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active<br /><br />boolean<br /><br />Conditionally returned               | Specifies whether the address is active.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                      |
| address\_1<br /><br />string<br /><br />Returned                          | Street name and number of the address.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                           |
| address\_2<br /><br />string<br /><br />Conditionally returned            | Additional address information.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                  |
| business\_token<br /><br />string<br /><br />Conditionally returned       | Unique identifier of the business account holder. This token is returned if a `user_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| city<br /><br />string<br /><br />Returned                                | City of the address.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                              |
| country<br /><br />string<br /><br />Returned                             | Country of the address.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                            |
| created\_time<br /><br />datetime<br /><br />Returned                     | Date and time when the resource was created, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                |
| first\_name<br /><br />string<br /><br />Returned                         | First or given name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                            |
| is\_default\_address<br /><br />boolean<br /><br />Conditionally returned | A value of `true` specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |
| last\_modified\_time<br /><br />datetime<br /><br />Returned              | Date and time when the resource was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />datetime<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                          |
| last\_name<br /><br />string<br /><br />Returned                          | Last name or family name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                       |
| phone<br /><br />string<br /><br />Conditionally returned                 | Telephone number of the cardholder.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                              |
| postal\_code<br /><br />string<br /><br />Returned                        | Postal code of the address.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                       |
| state<br /><br />string<br /><br />Returned                               | Two-character state, provincial, or territorial abbreviation.<br /><br />For the complete list, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                       |
| token<br /><br />string<br /><br />Returned                               | Unique identifier of the address object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                           |
| user\_token<br /><br />string<br /><br />Conditionally returned           | Unique identifier of the user account holder. This token is returned if a `business_token` is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                       |
| zip<br /><br />string<br /><br />Returned                                 | United States ZIP code of the address. This field is returned if `postal_code` is not specified.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                  |

<h3 id="_sample_response_body_5">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "business_token": "my_business_01",
  "token": "my_funding_source_address_biz_01",
  "first_name": "Jane",
  "last_name": "Doe",
  "address_1": "333 Elm Street",
  "city": "Berkeley",
  "state": "CA",
  "postal_code": "94705",
  "zip": "94705",
  "country": "USA",
  "phone": "5104444444",
  "is_default_address": true,
  "active": true,
  "created_time": "2023-02-20T20:04:13Z",
  "last_modified_time": "2023-02-28T16:00:00Z"
}
```


## Related topics

- [About Address Verification](/docs/developer-guides/about-address-verification.md)
- [Address Verification Service](/docs/developer-guides/mq-eu-avs.md)
- [Token Provision Schema](/docs/developer-guides/token-provision-rt-schema.md)
- [Transactions](/docs/core-api/transactions.md)
- [GPA Orders](/docs/core-api/gpa-orders.md)
