---
updatedAt: 2026-09-23T17:23:54.000Z
agentTools:
  projectIndex: https://docs.astrada.co/llms.txt
---

# Create network bulk enrollment

Starts a bulk enrollment kickoff for a whole card program. The request records the
company, the card program admin, an optional bank contact and program size, and the
admin's consent, and Astrada's onboarding team takes it from there with the issuing
bank. The Unified Enrollment SDK calls this endpoint when an admin sends the bulk
kickoff form (in SDK v1, with `bulkFlow: "kickoff"`); you can also call it directly.

Nothing is enrolled yet at this point. Once the bank has issued the network
reference, register the feed with `POST /network-bulk-feeds` and pass this
enrollment's `id` as `networkBulkEnrollmentId`; the enrollment then moves to
`feed-created` and links to the feed.

The subaccount must belong to the calling account. The BIN's bulk eligibility is not
re-checked here. A validation failure or an unknown subaccount answers `400`.

A program has one open kickoff at a time. A program is the calling account, the
`subaccountId`, the `network` and the first 8 digits of the `bin`; a `bin` shorter than
8 digits matches only a kickoff with exactly the same digits. A kickoff is open while it
is `requested` and was created less than 90 days ago, or while it is `feed-created` and
its feed is live (not `failed` or `deactivated`, and not deleted), at any age. When the
program already has an open kickoff that another request wrote, this request stores
nothing and answers `200` with that kickoff's summary (`alreadyOpen: true`), whatever
new `requestId` it sent, or none. No second request reaches Astrada's onboarding team.
Two kickoffs for one program sent at the same time store one kickoff between them.

The 90 days count from the kickoff's `createdAt`. Once a `requested` kickoff is 90 days
old it stops holding its program: nothing is written to it, it keeps its state and can
still be read, and the next kickoff for the program is created with `201`. A `cancelled`
kickoff, or one whose feed failed, was deactivated or was deleted, does not hold its
program either.

Requires the `network-bulk-enrollments:write` scope. Tokens that only hold
`network-bulk-feeds:write` are still accepted, so existing integrations keep working.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Astrada API",
    "version": "2024-02-28",
    "contact": {
      "email": "developer@astrada.co"
    },
    "description": "Welcome to our API Reference. 👋\n"
  },
  "servers": [
    {
      "url": "https://api.astrada.co"
    }
  ],
  "tags": [
    {
      "name": "network-bulk-enrollments",
      "description": "Network bulk enrollment resource. A kickoff request to enroll a whole card program, fulfilled later by a network bulk feed. A confirmation request asks Astrada to check that a card program can join a bulk feed; it is never a kickoff."
    }
  ],
  "externalDocs": {
    "description": "Find out more about Astrada API.",
    "url": "https://docs.astrada.co/reference"
  },
  "paths": {
    "/network-bulk-enrollments": {
      "post": {
        "tags": [
          "network-bulk-enrollments"
        ],
        "summary": "Create network bulk enrollment",
        "description": "Starts a bulk enrollment kickoff for a whole card program. The request records the\ncompany, the card program admin, an optional bank contact and program size, and the\nadmin's consent, and Astrada's onboarding team takes it from there with the issuing\nbank. The Unified Enrollment SDK calls this endpoint when an admin sends the bulk\nkickoff form (in SDK v1, with `bulkFlow: \"kickoff\"`); you can also call it directly.\n\nNothing is enrolled yet at this point. Once the bank has issued the network\nreference, register the feed with `POST /network-bulk-feeds` and pass this\nenrollment's `id` as `networkBulkEnrollmentId`; the enrollment then moves to\n`feed-created` and links to the feed.\n\nThe subaccount must belong to the calling account. The BIN's bulk eligibility is not\nre-checked here. A validation failure or an unknown subaccount answers `400`.\n\nA program has one open kickoff at a time. A program is the calling account, the\n`subaccountId`, the `network` and the first 8 digits of the `bin`; a `bin` shorter than\n8 digits matches only a kickoff with exactly the same digits. A kickoff is open while it\nis `requested` and was created less than 90 days ago, or while it is `feed-created` and\nits feed is live (not `failed` or `deactivated`, and not deleted), at any age. When the\nprogram already has an open kickoff that another request wrote, this request stores\nnothing and answers `200` with that kickoff's summary (`alreadyOpen: true`), whatever\nnew `requestId` it sent, or none. No second request reaches Astrada's onboarding team.\nTwo kickoffs for one program sent at the same time store one kickoff between them.\n\nThe 90 days count from the kickoff's `createdAt`. Once a `requested` kickoff is 90 days\nold it stops holding its program: nothing is written to it, it keeps its state and can\nstill be read, and the next kickoff for the program is created with `201`. A `cancelled`\nkickoff, or one whose feed failed, was deactivated or was deleted, does not hold its\nprogram either.\n\nRequires the `network-bulk-enrollments:write` scope. Tokens that only hold\n`network-bulk-feeds:write` are still accepted, so existing integrations keep working.\n",
        "security": [
          {
            "main-auth": [
              "network-bulk-enrollments:write"
            ]
          },
          {
            "main-auth": [
              "network-bulk-feeds:write"
            ]
          }
        ],
        "operationId": "CreateNetworkBulkEnrollment",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "subaccountId",
                  "network",
                  "bin",
                  "company",
                  "cardAdmin",
                  "outreach",
                  "consent"
                ],
                "properties": {
                  "requestId": {
                    "description": "Optional. Your idempotency key for this enrollment, unique per account. Repeating the\nrequest with a `requestId` that was already used returns the stored enrollment, whole\nand unchanged, with `200` instead of creating a second one with `201`. A request\nwithout a `requestId` is never a replay: it creates a new enrollment unless its\nprogram already has an open kickoff, which answers `200` with that kickoff's summary.\n",
                    "type": "string",
                    "format": "uuid"
                  },
                  "subaccountId": {
                    "description": "The subaccount the card program enrolls into. Must belong to the calling account.",
                    "type": "string",
                    "format": "uuid"
                  },
                  "network": {
                    "description": "The network of the card program.",
                    "type": "string",
                    "enum": [
                      "AMEX",
                      "MASTERCARD",
                      "VISA"
                    ]
                  },
                  "bin": {
                    "description": "The leading 6 to 11 digits of the card that opened the kickoff.",
                    "type": "string",
                    "pattern": "^[0-9]{6,11}$"
                  },
                  "binInfo": {
                    "description": "Optional. The issuer details shown to the person submitting the kickoff, in\nthe `GET /bin-lookup` vocabulary. Stored as a display snapshot only; every\nfield is optional.\n",
                    "type": "object",
                    "properties": {
                      "issuerName": {
                        "type": "string",
                        "maxLength": 200,
                        "description": "The name of the issuing bank."
                      },
                      "issuerCountry": {
                        "type": "string",
                        "description": "The country of the issuing bank, ISO 3166 alpha-3."
                      },
                      "type": {
                        "type": "string",
                        "maxLength": 50,
                        "description": "The card type, for example `COMMERCIAL`."
                      },
                      "fundingType": {
                        "type": "string",
                        "maxLength": 50,
                        "description": "The card funding type, for example `CREDIT`."
                      }
                    }
                  },
                  "company": {
                    "type": "object",
                    "required": [
                      "legalName"
                    ],
                    "properties": {
                      "legalName": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200,
                        "description": "The company's legal name, exactly as it reads on the card agreement."
                      }
                    }
                  },
                  "cardAdmin": {
                    "description": "The card program administrator. Astrada keeps this person engaged throughout onboarding.",
                    "type": "object",
                    "required": [
                      "name",
                      "email"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      "email": {
                        "type": "string",
                        "format": "email",
                        "maxLength": 320
                      }
                    }
                  },
                  "bankContact": {
                    "description": "Optional. The company's relationship contact at the issuing bank.",
                    "type": "object",
                    "required": [
                      "name",
                      "email"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      "email": {
                        "type": "string",
                        "format": "email",
                        "maxLength": 320
                      }
                    }
                  },
                  "cardCountBand": {
                    "description": "Optional. The estimated number of cards in the program, as a band. An estimate helps the bank size the file.",
                    "type": "string",
                    "enum": [
                      "1-50",
                      "51-250",
                      "251-1000",
                      "1001-5000",
                      "5001-25000",
                      "25000+"
                    ]
                  },
                  "cardCount": {
                    "description": "Optional. The estimated number of cards in the program. When sent, it decides the stored `cardCountBand`, even if `cardCountBand` is also sent.",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 1000000
                  },
                  "outreach": {
                    "description": "Who contacts the bank. `astrada`: Astrada reaches out to the bank, copying the\ncompany and the card admin. `self`: the company emails the bank itself and\ncopies onboarding@astrada.co so Astrada can guide the setup.\n",
                    "type": "string",
                    "enum": [
                      "astrada",
                      "self"
                    ]
                  },
                  "consent": {
                    "description": "The card admin's approval for the company and Astrada to start bulk enrollment with the bank, including contacting the bank on the company's behalf.",
                    "type": "object",
                    "required": [
                      "accepted",
                      "version"
                    ],
                    "properties": {
                      "accepted": {
                        "description": "Must be `true`. The request is rejected with a 400 otherwise.",
                        "type": "boolean",
                        "enum": [
                          true
                        ]
                      },
                      "version": {
                        "description": "The version of the consent wording that was accepted, for example `kickoff-consent-v1`. Stored as an opaque string.",
                        "type": "string"
                      }
                    }
                  },
                  "customerReferenceId": {
                    "description": "Optional. Your own id for this enrollment, echoed back on the resource.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  }
                }
              },
              "examples": {
                "Create Network Bulk Enrollment Request Example (Astrada outreach)": {
                  "value": {
                    "requestId": "3f8a1c52-7d4e-4b19-9c06-5e2b8d7a9f14",
                    "subaccountId": "24c4f90d-ab3b-4f6e-8a1d-d251a4fcf34c",
                    "network": "MASTERCARD",
                    "bin": "51075500",
                    "binInfo": {
                      "issuerName": "Jack Henry And Associates",
                      "issuerCountry": "USA",
                      "type": "COMMERCIAL",
                      "fundingType": "CREDIT"
                    },
                    "company": {
                      "legalName": "Vertex Industries, Inc."
                    },
                    "cardAdmin": {
                      "name": "Dana Whitfield",
                      "email": "dana.whitfield@vertexind.com"
                    },
                    "bankContact": {
                      "name": "Sam Lee",
                      "email": "sam.lee@bank.example"
                    },
                    "cardCountBand": "251-1000",
                    "cardCount": 400,
                    "outreach": "astrada",
                    "consent": {
                      "accepted": true,
                      "version": "kickoff-consent-v1"
                    },
                    "customerReferenceId": "outpave-customer-8842"
                  }
                },
                "Create Network Bulk Enrollment Request Example (self outreach, required fields only)": {
                  "value": {
                    "subaccountId": "24c4f90d-ab3b-4f6e-8a1d-d251a4fcf34c",
                    "network": "VISA",
                    "bin": "414720",
                    "company": {
                      "legalName": "Northwind Traders LLC"
                    },
                    "cardAdmin": {
                      "name": "Priya Natarajan",
                      "email": "priya.natarajan@northwind.example"
                    },
                    "outreach": "self",
                    "consent": {
                      "accepted": true,
                      "version": "kickoff-consent-v1"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A stored kickoff, returned unchanged, in one of two shapes:\n\n- An enrollment with this `requestId` already exists: the full enrollment, as your\n  request wrote it.\n- The program already has an open kickoff that another request wrote: its summary,\n  marked `alreadyOpen: true`, with the `requestId` this request sent (`null` when it\n  sent none) and only the `self` link. Names, emails, bank contact, `binInfo`, consent\n  and outreach are left out.\n",
            "content": {
              "application/hal+json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/network-bulk-enrollment"
                    },
                    {
                      "$ref": "#/components/schemas/network-bulk-enrollment-summary"
                    }
                  ]
                },
                "examples": {
                  "Example Repeat Network Bulk Enrollment Response (same requestId)": {
                    "$ref": "#/components/examples/network-bulk-enrollment"
                  },
                  "Example Network Bulk Enrollment Response (program already open)": {
                    "$ref": "#/components/examples/network-bulk-enrollment-summary"
                  }
                }
              }
            }
          },
          "201": {
            "description": "Resource created. The program had no open kickoff, so this request wrote one.",
            "content": {
              "application/hal+json": {
                "schema": {
                  "$ref": "#/components/schemas/network-bulk-enrollment"
                },
                "examples": {
                  "Example Create Network Bulk Enrollment Response": {
                    "$ref": "#/components/examples/network-bulk-enrollment"
                  },
                  "Example Create Network Bulk Enrollment Response (self outreach, required fields only)": {
                    "$ref": "#/components/examples/network-bulk-enrollment-minimal"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/bad-request"
          },
          "401": {
            "$ref": "#/components/responses/unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/forbidden"
          },
          "500": {
            "$ref": "#/components/responses/server-error"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "main-auth": {
        "type": "oauth2",
        "flows": {
          "implicit": {
            "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
            "refreshUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
            "scopes": {
              "accounts:write": "Accounts write resource",
              "accounts:read": "Accounts read resource",
              "subaccounts:write": "Subaccounts write resource",
              "subaccounts:read": "Subaccounts read resource",
              "card-connector-data-links:write": "card-connector-data-link resource",
              "card-connector-consents:read": "Card Consent read resource",
              "card-connector-consents:write": "Card Consent write resource",
              "webhooks:read": "Read Webhook resources",
              "webhooks:write": "Write Webhook resources",
              "card-subscriptions:write": "Create card subscription",
              "card-subscriptions:read": "Read card subscription",
              "card-verifications:write": "Create card verification",
              "card-verifications:read": "Read Card verification",
              "cards:read": "Read Card resources",
              "cardholder:read": "Read Cardholder resources",
              "cardholder:write": "Write Cardholder resources",
              "transactions:read": "Read Transaction resources",
              "transaction-messages:read": "Read Transaction Message resources",
              "network-bulk-feeds:read": "Read network bulk feed",
              "network-bulk-feeds:write": "Write network bulk feed",
              "network-bulk-enrollments:read": "Read network bulk enrollment",
              "network-bulk-enrollments:write": "Write network bulk enrollment and confirmation",
              "network-links:write": "Write network link",
              "enrollment-methods:write": "Write enrollment methods",
              "simulation:write": "Write sandbox simulations",
              "banking:read": "Read banking resources",
              "banking:write": "Write banking resources",
              "banking:admin": "Admin banking operations",
              "appstore:enrollment:write": "Enroll cards via the appstore B2C flow",
              "appstore:cards:read": "View enrolled cards in the appstore",
              "appstore:transactions:read": "View synced transactions in the appstore",
              "appstore:transactions:sync": "Trigger transaction sync in the appstore",
              "appstore:sessions:read": "Read appstore session state",
              "appstore:sessions:write": "Write or delete appstore session state",
              "appstore:tokens:read": "Read appstore stored tokens and connections",
              "appstore:tokens:write": "Write appstore stored tokens and connections"
            }
          }
        }
      }
    },
    "schemas": {
      "link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "templated": {
            "type": "boolean"
          },
          "type": {
            "type": "string"
          },
          "deprecation": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "profile": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "hreflang": {
            "type": "string"
          }
        },
        "required": [
          "href"
        ]
      },
      "network-bulk-enrollment": {
        "type": "object",
        "required": [
          "_links",
          "id",
          "subaccountId",
          "network",
          "bin",
          "binInfo",
          "company",
          "cardAdmin",
          "bankContact",
          "cardCountBand",
          "outreach",
          "consent",
          "state",
          "networkBulkFeedId",
          "customerReferenceId",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "_links": {
            "type": "object",
            "required": [
              "self"
            ],
            "properties": {
              "self": {
                "$ref": "#/components/schemas/link"
              },
              "networkBulkFeed": {
                "$ref": "#/components/schemas/link",
                "description": "The network bulk feed registered against this enrollment\n(`/network-bulk-feeds/{networkBulkFeedId}`). Present once `state` is\n`feed-created`, absent before that.\n"
              }
            }
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of this network bulk enrollment."
          },
          "subaccountId": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of the subaccount the card program enrolls into."
          },
          "network": {
            "type": "string",
            "enum": [
              "AMEX",
              "MASTERCARD",
              "VISA"
            ],
            "description": "The network of the card program."
          },
          "bin": {
            "type": "string",
            "pattern": "^[0-9]{6,11}$",
            "description": "The leading 6 to 11 digits of the card that opened the kickoff, exactly as submitted."
          },
          "binInfo": {
            "type": "object",
            "nullable": true,
            "description": "A snapshot of the issuer details shown to the person who submitted the kickoff,\nkept for display only. `null` when the request carried none. The fields use the\n`GET /bin-lookup` vocabulary.\n",
            "properties": {
              "issuerName": {
                "type": "string",
                "nullable": true,
                "description": "The name of the issuing bank."
              },
              "issuerCountry": {
                "type": "string",
                "nullable": true,
                "description": "The country of the issuing bank, ISO 3166 alpha-3."
              },
              "type": {
                "type": "string",
                "nullable": true,
                "description": "The card type, for example `COMMERCIAL`."
              },
              "fundingType": {
                "type": "string",
                "nullable": true,
                "description": "The card funding type, for example `CREDIT`."
              }
            }
          },
          "company": {
            "type": "object",
            "required": [
              "legalName"
            ],
            "properties": {
              "legalName": {
                "type": "string",
                "description": "The legal name of the company whose card program is being enrolled."
              }
            }
          },
          "cardAdmin": {
            "type": "object",
            "required": [
              "name",
              "email"
            ],
            "description": "The card program administrator. Astrada keeps this person engaged throughout onboarding.",
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string",
                "format": "email"
              }
            }
          },
          "bankContact": {
            "type": "object",
            "nullable": true,
            "required": [
              "name",
              "email"
            ],
            "description": "The company's relationship contact at the issuing bank. `null` when not provided.",
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string",
                "format": "email"
              }
            }
          },
          "cardCountBand": {
            "type": "string",
            "nullable": true,
            "enum": [
              "1-50",
              "51-250",
              "251-1000",
              "1001-5000",
              "5001-25000",
              "25000+",
              null
            ],
            "description": "The estimated number of cards in the program, as a band. `null` when not provided."
          },
          "outreach": {
            "type": "string",
            "enum": [
              "astrada",
              "self"
            ],
            "description": "Who contacts the bank. `astrada`: Astrada reaches out to the bank, copying the\ncompany and the card admin. `self`: the company emails the bank itself and copies\nonboarding@astrada.co so Astrada can guide the setup.\n"
          },
          "consent": {
            "type": "object",
            "required": [
              "acceptedAt",
              "version"
            ],
            "properties": {
              "acceptedAt": {
                "type": "string",
                "format": "date-time",
                "description": "When the consent was recorded, which is the server time of the create request, in UTC, following ISO 8601 format."
              },
              "version": {
                "type": "string",
                "description": "The version of the consent wording that was accepted, as sent by the client (for example `kickoff-consent-v1`)."
              }
            }
          },
          "state": {
            "type": "string",
            "enum": [
              "requested",
              "feed-created",
              "cancelled"
            ],
            "description": "`requested` until a network bulk feed is registered with this enrollment's id,\nthen `feed-created`. `cancelled` when the request is closed without a feed.\n"
          },
          "networkBulkFeedId": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "The network bulk feed registered with this enrollment's id on `POST /network-bulk-feeds`. `null` until then."
          },
          "customerReferenceId": {
            "type": "string",
            "nullable": true,
            "description": "An optional id passed by the customer to associate a context with the enrollment. `null` when not provided."
          },
          "createdAt": {
            "description": "Date and time when this resource was created, in UTC, following ISO 8601 format.",
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "description": "Date and time when this resource was last updated, in UTC, following ISO 8601 format.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "network-bulk-enrollment-summary": {
        "type": "object",
        "description": "The `200` body of `POST /network-bulk-enrollments` when the request's program already has\nan open kickoff that another request wrote. A program is the calling account, the\n`subaccountId`, the `network` and the first 8 digits of the `bin`. The summary names the\nopen kickoff and leaves out its contact details: no names, emails, bank contact, `binInfo`,\nconsent or outreach. `alreadyOpen` is always `true` here, and the full enrollment never\ncarries it, a replay of your own `requestId` included.\n",
        "required": [
          "_links",
          "alreadyOpen",
          "id",
          "subaccountId",
          "network",
          "state",
          "networkBulkFeedId",
          "requestId",
          "createdAt"
        ],
        "properties": {
          "_links": {
            "type": "object",
            "required": [
              "self"
            ],
            "properties": {
              "self": {
                "$ref": "#/components/schemas/link",
                "description": "The open kickoff (`/network-bulk-enrollments/{id}`). A token with\n`network-bulk-enrollments:read` or `network-bulk-feeds:read` can follow it to the\nfull enrollment; any other token gets `403`.\n"
              }
            }
          },
          "alreadyOpen": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Always `true`. Tells this summary apart from the full enrollment."
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of the open kickoff."
          },
          "subaccountId": {
            "type": "string",
            "format": "uuid",
            "description": "The subaccount of the open kickoff, the same as the request's."
          },
          "network": {
            "type": "string",
            "enum": [
              "AMEX",
              "MASTERCARD",
              "VISA"
            ],
            "description": "The network of the open kickoff, the same as the request's."
          },
          "state": {
            "type": "string",
            "enum": [
              "requested",
              "feed-created"
            ],
            "description": "The open kickoff's state. `requested`: it was created less than 90 days ago and no\nfeed has been registered against it yet. `feed-created`: a feed was registered against\nit and that feed is live.\n"
          },
          "networkBulkFeedId": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "The live feed registered against the open kickoff. `null` while the kickoff is `requested`."
          },
          "requestId": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "The `requestId` this request sent, or `null` when it sent none. It is never the\n`requestId` the open kickoff was stored under.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the open kickoff was created, in UTC, following ISO 8601 format. Its 90-day window counts from this time."
          }
        }
      }
    },
    "responses": {
      "bad-request": {
        "description": "The server cannot or will not process the request due to something that is perceived to be a client error",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string"
                },
                "title": {
                  "type": "string",
                  "enum": [
                    "Bad Request"
                  ]
                },
                "errors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string"
                      },
                      "detail": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "title",
                      "detail"
                    ]
                  }
                }
              },
              "required": [
                "detail",
                "title"
              ]
            },
            "examples": {
              "Example Generic Bad Request Payload Response": {
                "value": {
                  "title": "Bad Request",
                  "detail": "Request object failed validation."
                }
              },
              "Example Generic Bad Request Parameters Response": {
                "value": {
                  "title": "Bad Request",
                  "detail": "Request parameters are invalid."
                }
              }
            }
          }
        }
      },
      "unauthorized": {
        "description": "Authentication credentials were either missing or incorrect",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string"
                },
                "title": {
                  "type": "string",
                  "enum": [
                    "Unauthorized"
                  ]
                }
              },
              "required": [
                "detail",
                "title"
              ]
            },
            "example": {
              "title": "Unauthorized",
              "detail": "Authentication credentials were either missing or incorrect."
            }
          }
        }
      },
      "forbidden": {
        "description": "Authentication credentials used do not have have permissions to perform the request",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string"
                },
                "title": {
                  "type": "string",
                  "enum": [
                    "Forbidden"
                  ]
                }
              },
              "required": [
                "detail",
                "title"
              ]
            },
            "example": {
              "title": "Forbidden",
              "detail": "You do not have permission to access the requested resource."
            }
          }
        }
      },
      "server-error": {
        "description": "The server encountered an unexpected condition that prevented it from fulfilling the request",
        "content": {
          "application/problem+json": {
            "schema": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string"
                },
                "title": {
                  "type": "string",
                  "enum": [
                    "Internal Server Error"
                  ]
                }
              },
              "required": [
                "detail",
                "title"
              ]
            },
            "example": {
              "title": "Internal Server Error",
              "detail": "The server encountered an unexpected condition that prevented it from fulfilling the request."
            }
          }
        }
      }
    },
    "examples": {
      "network-bulk-enrollment": {
        "description": "Example of a Network Bulk Enrollment resource, before a feed is registered",
        "value": {
          "_links": {
            "self": {
              "href": "/network-bulk-enrollments/9c1f0c4e-2f0e-4a9c-9a1b-0c1d2e3f4a5b"
            }
          },
          "id": "9c1f0c4e-2f0e-4a9c-9a1b-0c1d2e3f4a5b",
          "subaccountId": "24c4f90d-ab3b-4f6e-8a1d-d251a4fcf34c",
          "network": "MASTERCARD",
          "bin": "51075500",
          "binInfo": {
            "issuerName": "Jack Henry And Associates",
            "issuerCountry": "USA",
            "type": "COMMERCIAL",
            "fundingType": "CREDIT"
          },
          "company": {
            "legalName": "Vertex Industries, Inc."
          },
          "cardAdmin": {
            "name": "Dana Whitfield",
            "email": "dana.whitfield@vertexind.com"
          },
          "bankContact": {
            "name": "Sam Lee",
            "email": "sam.lee@bank.example"
          },
          "cardCountBand": "251-1000",
          "outreach": "astrada",
          "consent": {
            "acceptedAt": "2026-09-10T21:30:00.000Z",
            "version": "kickoff-consent-v1"
          },
          "state": "requested",
          "networkBulkFeedId": null,
          "customerReferenceId": "outpave-customer-8842",
          "createdAt": "2026-09-10T21:30:00.000Z",
          "updatedAt": "2026-09-10T21:30:00.000Z"
        }
      },
      "network-bulk-enrollment-summary": {
        "description": "Example of the summary returned when the program already has an open kickoff that another request wrote",
        "value": {
          "_links": {
            "self": {
              "href": "/network-bulk-enrollments/9c1f0c4e-2f0e-4a9c-9a1b-0c1d2e3f4a5b"
            }
          },
          "alreadyOpen": true,
          "id": "9c1f0c4e-2f0e-4a9c-9a1b-0c1d2e3f4a5b",
          "subaccountId": "24c4f90d-ab3b-4f6e-8a1d-d251a4fcf34c",
          "network": "MASTERCARD",
          "state": "requested",
          "networkBulkFeedId": null,
          "requestId": "6b0e2a94-3d71-4c58-9f2e-1a7c5d8b3e60",
          "createdAt": "2026-09-10T21:30:00.000Z"
        }
      },
      "network-bulk-enrollment-minimal": {
        "description": "Example of a Network Bulk Enrollment resource created with the required fields only (self outreach)",
        "value": {
          "_links": {
            "self": {
              "href": "/network-bulk-enrollments/2b7e4d10-6c3a-4f8e-9d21-5a0c7b9e1f43"
            }
          },
          "id": "2b7e4d10-6c3a-4f8e-9d21-5a0c7b9e1f43",
          "subaccountId": "24c4f90d-ab3b-4f6e-8a1d-d251a4fcf34c",
          "network": "VISA",
          "bin": "414720",
          "binInfo": null,
          "company": {
            "legalName": "Northwind Traders LLC"
          },
          "cardAdmin": {
            "name": "Priya Natarajan",
            "email": "priya.natarajan@northwind.example"
          },
          "bankContact": null,
          "cardCountBand": null,
          "outreach": "self",
          "consent": {
            "acceptedAt": "2026-09-11T08:05:12.000Z",
            "version": "kickoff-consent-v1"
          },
          "state": "requested",
          "networkBulkFeedId": null,
          "customerReferenceId": null,
          "createdAt": "2026-09-11T08:05:12.000Z",
          "updatedAt": "2026-09-11T08:05:12.000Z"
        }
      }
    }
  }
}
```