--- updatedAt: 2026-05-27T02:51:28.000Z agentTools: projectIndex: https://developers.bloomcredit.io/llms.txt --- # Create Consumer Event This endpoint is used to create various consumer events. All events are optional, but one, and only one, event must be provided. Within each event there are required attributes. Supported events: - `bankruptcy_filed`: Create a bankruptcy filed event. Starts the bankruptcy process and requires the bankruptcy `chapter`. - `bankruptcy_confirm`: Record that the court confirmed the bankruptcy plan. The chapter is carried over from the existing filed event. - `bankruptcy_reaffirmed`: Create a new consumer bankruptcy reaffirmed event. It is an agreement that the accounts in question will be paid in full or partially; use `partially_reaffirmed` to indicate which. - `bankruptcy_removal`: Bankruptcy voluntarily dismissed by consumer. - `bankruptcy_reaffirm_rescinded`: Bankruptcy reaffirmation has been rescinded by court ruling. - `bankruptcy_discharged`: Bankruptcy has been discharged and debts have been forgiven. Successfully completes the bankruptcy process. WARNING: Any bankruptcy event for a consumer will remove all authorized users from the consumer's accounts. If the bankruptcy is reversed, the authorized users will need to be added back to the accounts. # OpenAPI definition ```json { "components": { "schemas": { "AddressNormalized": { "properties": { "city": { "title": "City", "type": "string", "description": "City or locality for the address.", "example": "Los Angeles" }, "line1": { "title": "Line1", "type": "string", "description": "Primary street-address line.", "example": "123 Main St" }, "line2": { "title": "Line2", "type": "string", "description": "Secondary address line, such as an apartment or suite.", "example": "Apt 4B" }, "stateCode": { "title": "Statecode", "type": "string", "description": "State code associated with this resource.", "example": "state-code" }, "zipcode": { "title": "Zipcode", "type": "string", "description": "Postal code for the address.", "example": "90001" } }, "required": [ "line1", "city", "stateCode", "zipcode" ], "title": "AddressNormalized", "type": "object", "description": "Represents address normalized." }, "AddressType": { "description": "Status of the reported address belonging to the primary consumer on the account.\n\n- `CONFIRMED`: Confirmed/Verified address.\n Note: reported one time once address is confirmed, after receiving an\n address discrepancy notification from a consumer reporting agency.\n- `KNOWN`: Known to be address of primary consumer.\n- `NOT_CONFIRMED`: Not confirmed address.\n- `MILITARY`: Military address.\n- `SECONDARY`: Secondary address.\n- `BUSINESS`: Business address — not consumer's residence\n- `UNDELIVERABLE`: Non-deliverable address/Returned mail\n- `DEFAULT`: Data reporter's default address\n- `BILL_PAYER_SERVICE`: Bill Payer Service — not consumer's residence", "enum": [ "CONFIRMED", "KNOWN", "NOT_CONFIRMED", "MILITARY", "SECONDARY", "BUSINESS", "UNDELIVERABLE", "DEFAULT", "BILL_PAYER_SERVICE" ], "title": "AddressType", "type": "string" }, "BankruptcyChapter": { "description": "An enumeration.", "enum": [ "CHAPTER_7", "CHAPTER_11", "CHAPTER_12", "CHAPTER_13" ], "title": "BankruptcyChapter", "type": "string" }, "BankruptcyConfirmedEvent": { "properties": { "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "title": "BankruptcyConfirmedEvent", "type": "object", "description": "Represents bankruptcy confirmed event." }, "BankruptcyDischargedEvent": { "properties": { "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "title": "BankruptcyDischargedEvent", "type": "object", "description": "Represents bankruptcy discharged event." }, "BankruptcyFiledEvent": { "properties": { "chapter": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyChapter" } ], "description": "Bankruptcy chapter under which the case was filed." }, "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "required": [ "chapter" ], "title": "BankruptcyFiledEvent", "type": "object", "description": "Represents bankruptcy filed event." }, "BankruptcyReaffirmedEvent": { "properties": { "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "partially_reaffirmed": { "default": false, "title": "Partially Reaffirmed", "type": "boolean", "description": "Whether only part of the consumer's affected debt was reaffirmed.", "example": false }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "title": "BankruptcyReaffirmedEvent", "type": "object", "description": "Represents bankruptcy reaffirmed event." }, "BankruptcyReaffirmedRescindedEvent": { "properties": { "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "title": "BankruptcyReaffirmedRescindedEvent", "type": "object", "description": "Represents bankruptcy reaffirmed rescinded event." }, "BankruptcyStatus": { "description": "An enumeration.", "enum": [ "FILED", "REMOVAL", "DISCHARGED", "REAFFIRMED", "RESCINDED", "CONFIRMED" ], "title": "BankruptcyStatus", "type": "string" }, "BankruptcyRemovalEvent": { "properties": { "effective_date": { "format": "date", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" } }, "title": "BankruptcyRemovalEvent", "type": "object", "description": "Represents bankruptcy removal event." }, "ConsumerEventBankruptcyResponse": { "description": "A response that includes the bankruptcy and the most recent event.", "properties": { "chapter": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyChapter" } ], "description": "Bankruptcy chapter under which the case was filed." }, "consumer_id": { "format": "uuid", "title": "Consumer Id", "type": "string", "description": "Unique identifier of the consumer.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "effective_date": { "format": "date-time", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31T15:04:05Z" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "partially_reaffirmed": { "title": "Partially Reaffirmed", "type": "boolean", "description": "Whether only part of the consumer's affected debt was reaffirmed.", "example": false }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this request reverses the corresponding active event.", "example": false }, "reversed_on": { "format": "date-time", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31T15:04:05Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyStatus" } ], "description": "Current lifecycle or processing status." } }, "required": [ "effective_date" ], "title": "ConsumerEventBankruptcyResponse", "type": "object" }, "ConsumerEventRespBase": { "description": "Represents consumer event resp base.", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ResponseData_ConsumerEvent_" } ], "description": "Primary API resource payload." }, "included": { "items": { "description": "Included associated with this resource." }, "title": "Included", "type": "array", "description": "Collection of included." }, "links": { "additionalProperties": { "anyOf": [ { "type": "string", "description": "Links value associated with this resource.", "example": "links-value" }, { "$ref": "#/components/schemas/LinkHref" } ], "description": "Links value associated with this resource." }, "title": "Links", "type": "object", "description": "Links related to this resource or collection." }, "meta": { "title": "Meta", "type": "object", "description": "Metadata associated with the response." } }, "required": [ "data" ], "title": "ConsumerEventRespBase", "type": "object" }, "ConsumerEventResponse": { "description": "A consumer event response", "properties": { "addresses": { "items": { "anyOf": [ { "$ref": "#/components/schemas/app__schemas__consumer_hub__models__Address" }, { "$ref": "#/components/schemas/app__schemas__address__Address" } ], "description": "Addresse associated with this resource." }, "title": "Addresses", "type": "array", "description": "Postal addresses associated with the consumer." }, "bankruptcy": { "allOf": [ { "$ref": "#/components/schemas/ConsumerEventBankruptcyResponse" } ], "description": "Bankruptcy associated with this resource." }, "dob": { "format": "date", "title": "Dob", "type": "string", "description": "Dob associated with this resource.", "example": "2024-01-31" }, "first_name": { "title": "First Name", "type": "string", "description": "Consumer's legal given name.", "example": "Jordan" }, "generation_code": { "allOf": [ { "$ref": "#/components/schemas/GenerationCode" } ], "description": "Generational suffix associated with the consumer's name." }, "id": { "title": "Id", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "last_name": { "title": "Last Name", "type": "string", "description": "Consumer's legal family name.", "example": "Doe" }, "middle_name": { "title": "Middle Name", "type": "string", "description": "Consumer's legal middle name, when provided.", "example": "Lee" }, "phone_numbers": { "anyOf": [ { "items": { "allOf": [ { "$ref": "#/components/schemas/Phone" } ], "description": "Phone number associated with this resource." }, "type": "array", "description": "Collection of phone numbers." }, { "maxLength": 10, "minLength": 10, "pattern": "^[0-9]+$", "type": "string", "description": "Phone numbers associated with this resource. Minimum length: 10 characters. Maximum length: 10 characters.", "example": "1111111111" } ], "title": "Phone Numbers", "description": "Phone numbers associated with this resource." }, "ssn": { "title": "Ssn", "type": "string", "description": "Consumer's Social Security number; responses may mask this value.", "example": "666456789" } }, "required": [ "first_name", "last_name" ], "title": "ConsumerEventResponse", "type": "object" }, "ConsumerEvents": { "properties": { "bankruptcy_confirm": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyConfirmedEvent" } ], "description": "Event indicating that the court confirmed the bankruptcy plan." }, "bankruptcy_discharged": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyDischargedEvent" } ], "description": "Event indicating that the bankruptcy was discharged." }, "bankruptcy_filed": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyFiledEvent" } ], "description": "Bankruptcy filing event that starts the consumer bankruptcy lifecycle." }, "bankruptcy_reaffirm_rescinded": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyReaffirmedRescindedEvent" } ], "description": "Event indicating that a prior reaffirmation was rescinded." }, "bankruptcy_reaffirmed": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyReaffirmedEvent" } ], "description": "Event indicating that affected debt was reaffirmed." }, "bankruptcy_removal": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyRemovalEvent" } ], "description": "Event indicating that the bankruptcy filing was removed or dismissed." } }, "title": "ConsumerEvents", "type": "object", "description": "Consumer bankruptcy lifecycle events. Every event is individually optional, but exactly one must be supplied per request." }, "ConsumerEventsBase": { "properties": { "consumer_events": { "allOf": [ { "$ref": "#/components/schemas/ConsumerEvents" } ], "description": "Consumer bankruptcy event payload. Exactly one supported bankruptcy lifecycle event must be supplied." } }, "required": [ "consumer_events" ], "title": "ConsumerEventsBase", "type": "object", "description": "Represents consumer events base." }, "GenerationCode": { "description": "An enumeration.", "enum": [ "Jr", "Sr", "II", "III", "IV", "V", "VI", "VII", "VIII", "IX" ], "title": "GenerationCode", "type": "string" }, "JSONAPIError": { "properties": { "detail": { "default": "", "title": "Detail", "type": "string", "description": "Human-readable detail explaining the result or error.", "example": "detail" }, "status": { "title": "Status", "type": "integer", "description": "Bloom internal error code, computed as `error group * 100 + error number`. This is not the HTTP status code.", "example": 20404 }, "title": { "title": "Title", "type": "string", "description": "Short, human-readable summary of the error.", "example": "Not Found" } }, "required": [ "title" ], "title": "JSONAPIError", "type": "object", "description": "Error representation used when a request cannot be completed (jsonapierror)." }, "JSONAPIErrorResponse": { "properties": { "errors": { "items": { "allOf": [ { "$ref": "#/components/schemas/JSONAPIError" } ], "description": "Error associated with this resource." }, "title": "Errors", "type": "array", "description": "Errors that prevented the request from completing." } }, "required": [ "errors" ], "title": "JSONAPIErrorResponse", "type": "object", "description": "Error representation used when a request cannot be completed (jsonapierror response)." }, "LinkHref": { "properties": { "href": { "title": "Href", "type": "string", "description": "Href associated with this resource.", "example": "href" }, "meta": { "title": "Meta", "type": "object", "description": "Metadata associated with the response." } }, "required": [ "href", "meta" ], "title": "LinkHref", "type": "object", "description": "Represents link href." }, "Phone": { "properties": { "phoneNumber": { "title": "Phonenumber", "type": "string", "description": "Phone number associated with this resource.", "example": "phone-number" }, "primary": { "title": "Primary", "type": "boolean", "description": "Whether this is the resource's primary contact value.", "example": false }, "type": { "title": "Type", "type": "string", "description": "API resource type.", "example": "type" } }, "title": "Phone", "type": "object", "description": "Represents phone." }, "RequestData_ConsumerEvent_": { "description": "Represents request data consumer event.", "properties": { "attributes": { "allOf": [ { "$ref": "#/components/schemas/ConsumerEventsBase" } ], "description": "Domain attributes for this resource." }, "id": { "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "relationships": { "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/RequestRelationshipModel" } ], "description": "Relationships value associated with this resource." }, "title": "Relationships", "type": "object", "description": "API relationships to associated resources." }, "type": { "enum": [ "ConsumerEvent" ], "title": "Type", "type": "string", "description": "API resource type. Allowed values: `ConsumerEvent`.", "example": "ConsumerEvent" } }, "required": [ "type", "attributes" ], "title": "RequestData[ConsumerEvent]", "type": "object" }, "RequestRelationshipModel": { "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/ResourceIdentifier" }, { "items": { "allOf": [ { "$ref": "#/components/schemas/ResourceIdentifier" } ], "description": "Primary API resource payload." }, "type": "array", "description": "Primary API resource payload." } ], "title": "Data", "description": "Primary API resource payload." } }, "title": "RequestRelationshipModel", "type": "object", "description": "Represents request relationship model." }, "Request_ConsumerEvent_": { "description": "Request envelope for consumer event.", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequestData_ConsumerEvent_" } ], "description": "Primary API resource payload." } }, "required": [ "data" ], "title": "Request[ConsumerEvent]", "type": "object" }, "ResidenceType": { "description": "Optional, if not available or unknown, do not report.\n\nAttributes:\n- `OWNS`\n- `RENTS`", "enum": [ "OWNS", "RENTS" ], "title": "ResidenceType", "type": "string" }, "ResourceIdentifier": { "description": "https://jsonapi.org/format/#document-resource-identifier-objects", "properties": { "id": { "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "meta": { "title": "Meta", "type": "object", "description": "Metadata associated with the response." }, "type": { "title": "Type", "type": "string", "description": "API resource type.", "example": "type" } }, "required": [ "id", "type" ], "title": "ResourceIdentifier", "type": "object" }, "ResponseData_ConsumerEvent_": { "description": "Represents response data consumer event.", "properties": { "attributes": { "allOf": [ { "$ref": "#/components/schemas/ConsumerEventResponse" } ], "default": {}, "title": "Attributes", "description": "Domain attributes for this resource." }, "id": { "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "links": { "additionalProperties": { "anyOf": [ { "type": "string", "description": "Links value associated with this resource.", "example": "links-value" }, { "$ref": "#/components/schemas/LinkHref" } ], "description": "Links value associated with this resource." }, "title": "Links", "type": "object", "description": "Links related to this resource or collection." }, "relationships": { "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/ResponseRelationshipModel" } ], "description": "Relationships value associated with this resource." }, "title": "Relationships", "type": "object", "description": "API relationships to associated resources." }, "type": { "enum": [ "ConsumerEvent" ], "title": "Type", "type": "string", "description": "API resource type. Allowed values: `ConsumerEvent`.", "example": "ConsumerEvent" } }, "required": [ "id", "type" ], "title": "ResponseData[ConsumerEvent]", "type": "object" }, "ResponseRelationshipModel": { "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/ResourceIdentifier" }, { "items": { "allOf": [ { "$ref": "#/components/schemas/ResourceIdentifier" } ], "description": "Primary API resource payload." }, "type": "array", "description": "Primary API resource payload." } ], "title": "Data", "description": "Primary API resource payload." }, "links": { "additionalProperties": { "anyOf": [ { "type": "string", "description": "Links value associated with this resource.", "example": "links-value" }, { "$ref": "#/components/schemas/LinkHref" } ], "description": "Links value associated with this resource." }, "title": "Links", "type": "object", "description": "Links related to this resource or collection." }, "meta": { "title": "Meta", "type": "object", "description": "Metadata associated with the response." } }, "title": "ResponseRelationshipModel", "type": "object", "description": "Represents response relationship model." }, "StateCode": { "description": "States and their respective codes.\n\n- `AL`: ALABAMA\n- `AK`: ALASKA\n- `AS`: AMERICAN_SAMOA\n- `AZ`: ARIZONA\n- `AR`: ARKANSAS\n- `CA`: CALIFORNIA\n- `CO`: COLORADO\n- `CT`: CONNECTICUT\n- `DE`: DELAWARE\n- `DC`: DISTRICT_OF_COLUMBIA\n- `FM`: FEDERATED_STATES_OF\n- `FL`: FLORIDA\n- `GA`: GEORGIA\n- `GU`: GUAM\n- `HI`: HAWAII\n- `ID`: IDAHO\n- `IL`: ILLINOIS\n- `IN`: INDIANA\n- `IA`: IOWA\n- `KS`: KANSAS\n- `KY`: KENTUCKY\n- `LA`: LOUISIANA\n- `ME`: MAINE\n- `MH`: MARSHALL_ISLANDS\n- `MD`: MARYLAND\n- `MA`: MASSACHUSETTS\n- `MI`: MICHIGAN\n- `PR`: MICRONESIA_PUERTO_RICO\n- `AE`: MILITARY_IN_EUROPE_MIDDLE_EAST_AFRICA_CANADA\n- `AA`: MILITARY_IN_THE_AMERICAS_OTHER_THAN_CANADA\n- `AP`: MILITARY_IN_THE_PACIFIC_THEATER\n- `MN`: MINNESOTA\n- `MS`: MISSISSIPPI\n- `MO`: MISSOURI\n- `MT`: MONTANA\n- `NE`: NEBRASKA\n- `NV`: NEVADA\n- `NH`: NEW_HAMPSHIRE\n- `NJ`: NEW_JERSEY\n- `NM`: NEW_MEXICO\n- `NY`: NEW_YORK\n- `MP`: NORTHERN_MARIANA_ISLANDS\n- `NC`: NORTH_CAROLINA\n- `ND`: NORTH_DAKOTA\n- `OH`: OHIO\n- `OK`: OKLAHOMA\n- `OR`: OREGON\n- `PW`: PALAU\n- `PA`: PENNSYLVANIA\n- `RI`: RHODE_ISLAND\n- `SC`: SOUTH_CAROLINA\n- `SD`: SOUTH_DAKOTA\n- `TN`: TENNESSEE\n- `TX`: TEXAS\n- `UT`: UTAH\n- `VT`: VERMONT\n- `VA`: VIRGINIA\n- `VI`: VIRGIN_ISLANDS\n- `WA`: WASHINGTON\n- `WV`: WESTVIRGINIA\n- `WI`: WISCONSIN\n- `WY`: WYOMING", "enum": [ "AL", "AK", "AS", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FM", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MH", "MD", "MA", "MI", "PR", "AE", "AA", "AP", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "MP", "NC", "ND", "OH", "OK", "OR", "PW", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "VI", "WA", "WV", "WI", "WY" ], "title": "StateCode", "type": "string" }, "app__schemas__address__Address": { "description": "An Address that has been inserted into the db, and therefore contains an ID", "properties": { "address_type": { "allOf": [ { "$ref": "#/components/schemas/AddressType" } ], "description": "Address type associated with this resource." }, "city": { "title": "City", "type": "string", "description": "City or locality for the address.", "example": "Los Angeles" }, "country_code": { "default": "US", "title": "Country Code", "type": "string", "description": "ISO country code for the address.", "example": "US" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "line1": { "title": "Line1", "type": "string", "description": "Primary street-address line.", "example": "123 Main St" }, "line2": { "title": "Line2", "type": "string", "description": "Secondary address line, such as an apartment or suite.", "example": "Apt 4B" }, "residence_type": { "allOf": [ { "$ref": "#/components/schemas/ResidenceType" } ], "description": "Residence type associated with this resource." }, "state": { "allOf": [ { "$ref": "#/components/schemas/StateCode" } ], "description": "State or province for the address." }, "suburb": { "title": "Suburb", "type": "string", "description": "Suburb associated with this resource.", "example": "suburb" }, "zip_code": { "pattern": "\\d{5,9}", "title": "Zip Code", "type": "string", "description": "Zip code associated with this resource.", "example": "11111" } }, "required": [ "line1", "city", "state", "zip_code", "id" ], "title": "Address", "type": "object" }, "app__schemas__consumer_hub__models__Address": { "properties": { "city": { "title": "City", "type": "string", "description": "City or locality for the address.", "example": "Los Angeles" }, "countryCode": { "default": "US", "title": "Countrycode", "type": "string", "description": "Country code associated with this resource.", "example": "country-code" }, "hash": { "title": "Hash", "type": "string", "description": "Hash associated with this resource.", "example": "hash" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "line1": { "title": "Line1", "type": "string", "description": "Primary street-address line.", "example": "123 Main St" }, "line2": { "title": "Line2", "type": "string", "description": "Secondary address line, such as an apartment or suite.", "example": "Apt 4B" }, "normalized": { "allOf": [ { "$ref": "#/components/schemas/AddressNormalized" } ], "description": "Normalized associated with this resource." }, "primary": { "title": "Primary", "type": "boolean", "description": "Whether this is the resource's primary contact value.", "example": false }, "stateCode": { "title": "Statecode", "type": "string", "description": "State code associated with this resource.", "example": "state-code" }, "zipcode": { "title": "Zipcode", "type": "string", "description": "Postal code for the address.", "example": "90001" } }, "required": [ "line1", "city", "stateCode", "zipcode" ], "title": "Address", "type": "object", "description": "Represents app schemas consumer hub models address." } }, "securitySchemes": { "Oauth2ClientCredentials": { "flows": { "clientCredentials": { "scopes": { "furnishment:all": "Manage accounts." }, "tokenUrl": "https://authn.bloomcredit.dev/oauth2/token" } }, "type": "oauth2" } } }, "info": { "description": "API Gateway for all public facing endpoints", "title": "KrakenD - API Gateway", "version": "2.0" }, "openapi": "3.1.0", "paths": { "/v2/furnishment/consumers/{consumer_id}/events": { "post": { "description": "This endpoint is used to create various consumer events. All events are optional, but one,\nand only one, event must be provided. Within each event there are required attributes.\n\nSupported events:\n- `bankruptcy_filed`: Create a bankruptcy filed event. Starts the bankruptcy process and\n requires the bankruptcy `chapter`.\n- `bankruptcy_confirm`: Record that the court confirmed the bankruptcy plan. The chapter is\n carried over from the existing filed event.\n- `bankruptcy_reaffirmed`: Create a new consumer bankruptcy reaffirmed event. It is an\n agreement that the accounts in question will be paid in full or partially; use\n `partially_reaffirmed` to indicate which.\n- `bankruptcy_removal`: Bankruptcy voluntarily dismissed by consumer.\n- `bankruptcy_reaffirm_rescinded`: Bankruptcy reaffirmation has been rescinded by court\n ruling.\n- `bankruptcy_discharged`: Bankruptcy has been discharged and debts have been forgiven.\n Successfully completes the bankruptcy process.\n\nWARNING: Any bankruptcy event for a consumer will remove all authorized users from the\nconsumer's accounts. If the bankruptcy is reversed, the authorized users will need to be\nadded back to the accounts.", "operationId": "create_consumer_event_api_v1_consumers__consumer_id__events__post", "parameters": [ { "in": "path", "name": "consumer_id", "required": true, "schema": { "format": "uuid", "title": "Consumer Id", "type": "string", "description": "Unique identifier of the consumer.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "description": "Unique identifier of the consumer.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" } ], "requestBody": { "content": { "application/json": { "examples": { "valid-bankruptcy-filed-event": { "summary": "Create a Bankruptcy Filed event. Starts the bankruptcy process.", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_filed": { "chapter": "CHAPTER_7", "effective_date": "2022-01-24" } } }, "type": "ConsumerEvent" } } }, "valid-bankruptcy-confirm-event": { "summary": "Create a Bankruptcy Confirm event. Requires an existing filed event.", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_confirm": { "effective_date": "2022-01-24" } } }, "type": "ConsumerEvent" } } }, "valid-bankruptcy-reaffirm-event": { "summary": "Create a Bankruptcy Reaffirm event.", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_reaffirmed": { "effective_date": "2022-01-24", "partially_reaffirmed": true } } }, "type": "ConsumerEvent" } } }, "valid-bankruptcy-reaffirm-rescinded-event": { "summary": "Create a Bankruptcy Reaffirm Rescinded event", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_reaffirm_rescinded": { "effective_date": "2022-01-24" } } }, "type": "ConsumerEvent" } } }, "valid-bankruptcy-removal-event": { "summary": "Create a Bankruptcy Removal event", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_removal": { "effective_date": "2022-01-24" } } }, "type": "ConsumerEvent" } } }, "valid_bankruptcy_discharged_event": { "summary": "Create a Bankruptcy discharged event. Completes the bankruptcy.", "value": { "data": { "attributes": { "consumer_events": { "bankruptcy_discharged": { "effective_date": "2022-01-24" } } }, "type": "ConsumerEvent" } } } }, "schema": { "$ref": "#/components/schemas/Request_ConsumerEvent_" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerEventRespBase" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Consumer Not Found" }, "409": { "content": { "application/json": { "examples": { "Conflict detected from request. ": { "value": { "errors": [ { "detail": "The account be792bc3-a50e-4c77-abee-b9386839d3c6 is already in status BANKRUPTCY-FILED, can't create an event that already exists", "status": 481, "title": "Associated relationship id already exists" } ] } } }, "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Conflict detected from request. " }, "422": { "content": { "application/json": { "examples": { "Bad Request": { "value": { "errors": [ { "detail": "Invalid request body", "status": 429, "title": "Request validation error" } ] } } }, "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Bad Request" } }, "security": [ { "Oauth2ClientCredentials": [ "furnishment:all" ] } ], "summary": "Create Consumer Event", "tags": [ "Consumer Events" ] } } }, "servers": [ { "description": "Furnishment sandbox server, for testing purposes (v2)", "url": "https://sandbox.bloom.dev" }, { "description": "Furnishment server", "url": "https://api.bloomcredit.io" }, { "description": "Production Consumer Permissioned Data server", "url": "https://api.bloomplus.com" }, { "description": "Development Consumer Permissioned Data server", "url": "https://api.bloomplus.dev" } ] } ```