--- updatedAt: 2026-05-27T02:51:28.000Z agentTools: projectIndex: https://developers.bloomcredit.io/llms.txt --- # Create Statement Create a new statement. Duplicate statements return `409`, missing accounts return `404`, and account-state restrictions return `400`. # OpenAPI definition ```json { "components": { "schemas": { "AccountClosedInitiator": { "description": "An enumeration.", "enum": [ "CREDITOR", "CONSUMER" ], "title": "AccountClosedInitiator" }, "AccountDeleteEvent": { "properties": { "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "deleted_notes": { "title": "Deleted Notes", "type": "string", "description": "Free-form note explaining why the account was deleted.", "example": "Deleted at consumer request." }, "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" }, "external_delete_date": { "format": "date", "title": "External Delete Date", "type": "string", "description": "Date the partner recorded the deletion in its own system.", "example": "2024-01-31" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountDeletionReason" } ], "description": "Reason the account was deleted." } }, "title": "AccountDeleteEvent", "type": "object", "description": "Active deletion event recorded against an account." }, "AccountDeletionReason": { "description": "An enumeration.", "enum": [ "CONFIRMED_FRAUD", "OTHER_REASON_NOT_FRAUD" ], "title": "AccountDeletionReason" }, "BankruptcyChapter": { "description": "An enumeration.", "enum": [ "CHAPTER_7", "CHAPTER_11", "CHAPTER_12", "CHAPTER_13" ], "title": "BankruptcyChapter", "type": "string" }, "BankruptcyEvent": { "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", "title": "Effective Date", "type": "string", "description": "Date on which the event takes effect for furnishing and status calculations.", "example": "2024-01-31" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "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" }, "status": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "BankruptcyEvent", "type": "object", "description": "Represents bankruptcy event." }, "BankruptcyStatus": { "description": "An enumeration.", "enum": [ "FILED", "REMOVAL", "DISCHARGED", "REAFFIRMED", "RESCINDED", "CONFIRMED" ], "title": "BankruptcyStatus", "type": "string" }, "ChargeOff": { "properties": { "amount": { "minimum": 0, "title": "Amount", "type": "number", "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.", "example": 100 }, "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/ChargeOffSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ChargeOffStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "ChargeOff", "type": "object", "description": "Represents charge off." }, "ChargeOffSpecialCommentCode": { "description": "An enumeration.", "enum": [ "CHARGE_OFF", "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE", "CREDIT_LINE_SUSPENDED" ], "title": "ChargeOffSpecialCommentCode", "type": "string" }, "ChargeOffStatus": { "description": "An enumeration.", "enum": [ "CHARGE_OFF", "PAID_IN_FULL_CHARGE_OFF", "UNPAID_BALANCE_REPORTED_AS_LOSS" ], "title": "ChargeOffStatus", "type": "string" }, "Collateral": { "properties": { "amount": { "minimum": 0, "title": "Amount", "type": "number", "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.", "example": 100 }, "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/CollateralSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/CollateralStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "Collateral", "type": "object", "description": "Represents collateral." }, "CollateralSpecialCommentCode": { "description": "An enumeration.", "enum": [ "VOLUNTARY_SURRENDERED", "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE", "CREDIT_LINE_SUSPENDED", "CREDIT_LINE_REDUCED_DUE_TO_COLLATERAL_DEPRECIATION", "CREDIT_LINE_SUSPENDED_DUE_TO_COLLATERAL_DEPRECIATION", "COLLATERAL_RELEASED_BY_CREDITOR", "VOLUNTARY_SURRENDERED_REDEEMED_REINSTATED", "REPOSSESSION_REDEEMED_REINSTATED" ], "title": "CollateralSpecialCommentCode", "type": "string" }, "CollateralStatus": { "description": "An enumeration.", "enum": [ "VOLUNTARY_SURRENDERED", "PAID_IN_FULL_FORECLOSURE_WAS_STARTED", "DEED_RECEIVED_IN_LIEU_OF_FORECLOSURE_ON_DEFAULTED_MORTGAGE", "REPOSSESSION", "COLLATERAL_DEPRECIATION", "COLLATERAL_RELEASED", "SHORT_SALE", "LOAN" ], "title": "CollateralStatus", "type": "string" }, "Collections": { "properties": { "amount": { "minimum": 0, "title": "Amount", "type": "number", "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.", "example": 100 }, "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/CollectionsSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/CollectionsStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "Collections", "type": "object", "description": "Represents collections." }, "CollectionsSpecialCommentCode": { "description": "An enumeration.", "enum": [ "COLLECTIONS", "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE", "CREDIT_LINE_SUSPENDED" ], "title": "CollectionsSpecialCommentCode", "type": "string" }, "CollectionsStatus": { "description": "An enumeration.", "enum": [ "PAID_IN_FULL_COLLECTION_ACCOUNT" ], "title": "CollectionsStatus", "type": "string" }, "Forbearance": { "properties": { "amount": { "minimum": 0, "title": "Amount", "type": "number", "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.", "example": 100 }, "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/ForbearanceSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ForbearanceStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "Forbearance", "type": "object", "description": "Represents forbearance." }, "ForbearanceSpecialCommentCode": { "description": "An enumeration.", "enum": [ "ACCOUNT_IN_FORBEARANCE" ], "title": "ForbearanceSpecialCommentCode", "type": "string" }, "ForbearanceStatus": { "description": "An enumeration.", "enum": [ "FORBEARANCE" ], "title": "ForbearanceStatus", "type": "string" }, "Foreclosure": { "properties": { "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" }, "reversed": { "title": "Reversed", "type": "boolean", "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.", "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/ForeclosureStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "Foreclosure", "type": "object", "description": "Represents foreclosure." }, "ForeclosureStatus": { "description": "An enumeration.", "enum": [ "FORECLOSURE_STARTED", "FORECLOSURE_COMPLETED" ], "title": "ForeclosureStatus" }, "HTTPValidationError": { "properties": { "detail": { "items": { "allOf": [ { "$ref": "#/components/schemas/ValidationError" } ], "description": "Human-readable detail explaining the result or error." }, "title": "Detail", "type": "array", "description": "Human-readable detail explaining the result or error." } }, "title": "HTTPValidationError", "type": "object", "description": "Error representation used when a request cannot be completed (httpvalidation error)." }, "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)." }, "Lien": { "properties": { "amount": { "minimum": 0, "title": "Amount", "type": "number", "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.", "example": 100 }, "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/LienSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/LienStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "Lien", "type": "object", "description": "Represents lien." }, "LienSpecialCommentCode": { "description": "An enumeration.", "enum": [ "GOVERNMENT_CLAIM_FILED", "CREDIT_LINE_SUSPENDED" ], "title": "LienSpecialCommentCode", "type": "string" }, "LienStatus": { "description": "An enumeration.", "enum": [ "CLAIM_FILED_WITH_GOVT_FOR_INSURED_PORTION_ON_DEFAULTED_LOAN" ], "title": "LienStatus", "type": "string" }, "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." }, "PaymentDefaultEvent": { "properties": { "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/PaymentDefaultSpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/PaymentDefaultStatus" } ], "description": "Current lifecycle or processing status." } }, "title": "PaymentDefaultEvent", "type": "object", "description": "Represents payment default event." }, "PaymentDefaultSpecialCommentCode": { "description": "Metro 2 special comment code reported for a first-payment default.", "enum": [ "FIRST_PAYMENT_NEVER_RECEIVED" ], "title": "PaymentDefaultSpecialCommentCode", "type": "string" }, "PaymentDefaultStatus": { "description": "Status to perform the reverse operation", "enum": [ "FIRST_PAYMENT_NEVER_RECEIVED" ], "title": "PaymentDefaultStatus", "type": "string" }, "RequestData_StatementCreate_": { "description": "Represents request data statement create.", "properties": { "attributes": { "allOf": [ { "$ref": "#/components/schemas/StatementCreate" } ], "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": [ "StatementCreate" ], "title": "Type", "type": "string", "description": "API resource type. Allowed values: `StatementCreate`.", "example": "StatementCreate" } }, "required": [ "type", "attributes" ], "title": "RequestData[StatementCreate]", "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_StatementCreate_": { "description": "Request envelope for statement create.", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequestData_StatementCreate_" } ], "description": "Primary API resource payload." } }, "required": [ "data" ], "title": "Request[StatementCreate]", "type": "object" }, "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_Statement_": { "description": "Represents response data statement.", "properties": { "attributes": { "allOf": [ { "$ref": "#/components/schemas/StatementResponse" } ], "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": [ "Statement" ], "title": "Type", "type": "string", "description": "API resource type. Allowed values: `Statement`.", "example": "Statement" } }, "required": [ "id", "type" ], "title": "ResponseData[Statement]", "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." }, "Response_Statement_": { "description": "Response envelope for statement.", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ResponseData_Statement_" } ], "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": "Response[Statement]", "type": "object" }, "SecondaryConsumerEvent": { "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string", "description": "Unique identifier of the furnished account.", "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" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string", "description": "Unique identifier of the organization that owns the resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "removal_type": { "allOf": [ { "$ref": "#/components/schemas/SecondaryRemovalType" } ], "description": "Removal type associated with this resource." }, "reversed": { "title": "Reversed", "type": "boolean", "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.", "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/SecondaryStatus" } ], "description": "Current lifecycle or processing status." } }, "required": [ "id", "organization_id", "account_id" ], "title": "SecondaryConsumerEvent", "type": "object", "description": "Represents secondary consumer event." }, "SecondaryRemovalType": { "description": "An enumeration.", "enum": [ "TERMINATED", "DELETE_CONSUMER" ], "title": "SecondaryRemovalType" }, "SecondaryStatus": { "description": "An enumeration.", "enum": [ "ADD_SECONDARY_CONSUMER", "REMOVE_SECONDARY_CONSUMER" ], "title": "SecondaryStatus" }, "SpecialCommentCode": { "description": "An enumeration.", "enum": [ "ACCOUNT_CLOSED_AT_CREDIT_GRANTORS_REQUEST", "VOLUNTARY_SURRENDERED", "ACCOUNT_CLOSED_DUE_TO_REFINANCE", "ACCOUNT_CLOSED_DUE_TO_TRANSFER", "REDEEMED_OR_REINSTATED_REPOSSESSION", "CREDIT_CARD_LOST_OR_STOLEN", "ACCOUNT_CLOSED_DUE_TO_INACTIVITY", "CREDIT_LINE_NO_LONGER_AVAILABLE", "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE" ], "title": "SpecialCommentCode" }, "StatementCreate": { "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string", "description": "Unique identifier of the furnished account.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "actual_monthly_payment": { "minimum": 0, "title": "Actual Monthly Payment", "type": "number", "description": "Payment received during the statement period. Must be a non-negative monetary amount.", "example": 125 }, "amount_past_due": { "minimum": 0, "title": "Amount Past Due", "type": "number", "description": "Total amount past due as of the statement date. Must be a non-negative monetary amount.", "example": 0 }, "credit_limit": { "minimum": 0, "title": "Credit Limit", "type": "number", "description": "Credit limit as of the statement date. Must be non-negative and supports at most 15 digits with two decimal places.", "example": 5000 }, "current_balance": { "minimum": 0, "title": "Current Balance", "type": "number", "description": "Outstanding balance as of the statement date. Must be non-negative and supports at most 15 digits with two decimal places.", "example": 1250.75 }, "days_delinquent": { "default": 0, "title": "Days Delinquent", "type": "integer", "description": "Number of days past due as of the statement date. Defaults to zero; explicit `null` is rejected.", "example": 0 }, "highest_balance": { "default": 0, "minimum": 0, "title": "Highest Balance", "type": "number", "description": "Highest account balance reported for the period. Defaults to zero; explicit `null` is rejected.", "example": 0 }, "last_payment_date": { "format": "date", "title": "Last Payment Date", "type": "string", "description": "Date of the most recent consumer payment known for this statement.", "example": "2024-01-31" }, "scheduled_monthly_payment": { "minimum": 0, "title": "Scheduled Monthly Payment", "type": "number", "description": "Contractual payment due for the statement period. Must be a non-negative monetary amount.", "example": 125 }, "statement_date": { "format": "date", "title": "Statement Date", "type": "string", "description": "Reporting date represented by this statement.", "example": "2024-01-31" }, "statement_identifier": { "title": "Statement Identifier", "type": "string", "description": "Partner-supplied identifier used to deduplicate and correlate the statement; stored tokenized by the service.", "example": "monthly-2024-01-123433578" } }, "required": [ "account_id", "statement_date", "current_balance", "credit_limit", "scheduled_monthly_payment", "actual_monthly_payment", "amount_past_due", "statement_identifier" ], "title": "StatementCreate", "type": "object", "description": "Attributes accepted when creating a statement." }, "StatementResponse": { "description": "A detokenized statement record, containing point-in-time account information, and\npayments collected during the statement period", "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string", "description": "Unique identifier of the furnished account.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "actual_monthly_payment": { "minimum": 0, "title": "Actual Monthly Payment", "type": "number", "description": "Payment actually received during the statement period, expressed in dollars. Minimum: 0.", "example": 125 }, "amount_past_due": { "minimum": 0, "title": "Amount Past Due", "type": "number", "description": "Total amount past due as of the statement date, expressed in dollars. Minimum: 0.", "example": 0 }, "bankruptcy": { "allOf": [ { "$ref": "#/components/schemas/BankruptcyEvent" } ], "description": "Bankruptcy associated with this resource." }, "charge_off": { "allOf": [ { "$ref": "#/components/schemas/ChargeOff" } ], "description": "Charge off associated with this resource." }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/Collateral" } ], "description": "Collateral associated with this resource." }, "collections": { "allOf": [ { "$ref": "#/components/schemas/Collections" } ], "description": "Collections associated with this resource." }, "credit_limit": { "minimum": 0, "title": "Credit Limit", "type": "number", "description": "Maximum credit available on the account, expressed in dollars. Minimum: 0.", "example": 5000 }, "credit_product_id": { "format": "uuid", "title": "Credit Product Id", "type": "string", "description": "Unique identifier of the credit product whose reporting rules apply.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "current_balance": { "minimum": 0, "title": "Current Balance", "type": "number", "description": "Outstanding account balance as of the statement date, expressed in dollars. Minimum: 0.", "example": 1250.75 }, "days_delinquent": { "default": 0, "title": "Days Delinquent", "type": "integer", "description": "Number of days the account is past due as of the statement date.", "example": 0 }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/AccountDeleteEvent" } ], "description": "Deleted associated with this resource." }, "forbearance": { "allOf": [ { "$ref": "#/components/schemas/Forbearance" } ], "description": "Forbearance associated with this resource." }, "foreclosure": { "allOf": [ { "$ref": "#/components/schemas/Foreclosure" } ], "description": "Foreclosure associated with this resource." }, "highest_balance": { "default": 0, "minimum": 0, "title": "Highest Balance", "type": "number", "description": "Highest balance associated with this resource. Minimum: 0.", "example": 0 }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "last_payment_date": { "format": "date", "title": "Last Payment Date", "type": "string", "description": "Date of the most recent consumer payment known for this statement.", "example": "2024-01-31" }, "lien": { "allOf": [ { "$ref": "#/components/schemas/Lien" } ], "description": "Lien associated with this resource." }, "payment_default": { "allOf": [ { "$ref": "#/components/schemas/PaymentDefaultEvent" } ], "description": "Payment default associated with this resource." }, "positions": { "allOf": [ { "$ref": "#/components/schemas/app__schemas__v1__account__account_position__response__AccountPosition" } ], "description": "Positions associated with this resource." }, "scheduled_monthly_payment": { "minimum": 0, "title": "Scheduled Monthly Payment", "type": "number", "description": "Payment contractually due for the statement period, expressed in dollars. Minimum: 0.", "example": 125 }, "secondary_consumer_events": { "default": [], "items": { "allOf": [ { "$ref": "#/components/schemas/SecondaryConsumerEvent" } ], "description": "Secondary consumer event associated with this resource." }, "title": "Secondary Consumer Events", "type": "array", "description": "Collection of secondary consumer events." }, "statement_date": { "format": "date", "title": "Statement Date", "type": "string", "description": "Reporting date represented by this statement.", "example": "2024-01-31" }, "statement_identifier": { "title": "Statement Identifier", "type": "string", "description": "Partner-supplied identifier used to deduplicate and correlate the statement.", "example": "monthly-2024-01-123433578" }, "transfer": { "allOf": [ { "$ref": "#/components/schemas/Transfer" } ], "description": "Transfer associated with this resource." } }, "required": [ "account_id", "statement_date", "current_balance", "credit_limit", "scheduled_monthly_payment", "actual_monthly_payment", "amount_past_due", "statement_identifier", "id" ], "title": "StatementResponse", "type": "object" }, "Transfer": { "properties": { "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" }, "reversed": { "title": "Reversed", "type": "boolean", "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.", "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/TransferStatus" } ], "description": "Current lifecycle or processing status." }, "transfer_type": { "allOf": [ { "$ref": "#/components/schemas/TransferType" } ], "description": "Transfer type associated with this resource." } }, "title": "Transfer", "type": "object", "description": "Represents transfer." }, "TransferStatus": { "description": "An enumeration.", "enum": [ "TRANSFER", "REMOVE_TRANSFER" ], "title": "TransferStatus", "type": "string" }, "TransferType": { "description": "An enumeration.", "enum": [ "SELL", "BUY" ], "title": "TransferType", "type": "string" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string", "description": "Loc associated with this resource.", "example": "loc" }, { "type": "integer", "description": "Loc associated with this resource.", "example": 0 } ], "description": "Loc associated with this resource." }, "title": "Location", "type": "array", "description": "Collection of loc." }, "msg": { "title": "Message", "type": "string", "description": "Msg associated with this resource.", "example": "msg" }, "type": { "title": "Error Type", "type": "string", "description": "API resource type.", "example": "type" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object", "description": "Error representation used when a request cannot be completed (validation error)." }, "app__schemas__v1__account__account_position__enums__AccountPosition": { "description": "Account Position events that represent position changes on an account\"", "enum": [ "ACCOUNT_CLOSED", "CREDIT_LINE_SUSPENDED" ], "title": "AccountPosition" }, "app__schemas__v1__account__account_position__response__AccountPosition": { "properties": { "created_at": { "format": "date", "title": "Created At", "type": "string", "description": "Date on which the event was recorded by the service.", "example": "2024-01-31" }, "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" }, "id": { "format": "uuid", "title": "Id", "type": "string", "description": "Stable identifier for this resource.", "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2" }, "initiator": { "allOf": [ { "$ref": "#/components/schemas/AccountClosedInitiator" } ], "description": "Party that initiated the account action." }, "initiator_reversed": { "title": "Initiator Reversed", "type": "boolean", "description": "Whether initiator reversed applies.", "example": false }, "initiator_reversed_on": { "format": "date-time", "title": "Initiator Reversed On", "type": "string", "description": "Date on which the initiator designation was reversed.", "example": "2024-01-31T15:04:05Z" }, "reverse": { "title": "Reverse", "type": "boolean", "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.", "example": true }, "reversed_on": { "format": "date", "title": "Reversed On", "type": "string", "description": "Date on which the previously reported event was reversed.", "example": "2024-01-31" }, "special_comment_code": { "allOf": [ { "$ref": "#/components/schemas/SpecialCommentCode" } ], "description": "Metro 2 special comment code applied by this event." }, "status": { "allOf": [ { "$ref": "#/components/schemas/app__schemas__v1__account__account_position__enums__AccountPosition" } ], "description": "Current lifecycle or processing status." } }, "title": "AccountPosition", "type": "object", "description": "Represents app schemas v1 account account position response account position." } }, "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/statements": { "post": { "description": "Create a new statement. Duplicate statements return `409`, missing accounts return `404`, and account-state restrictions return `400`.", "operationId": "create_statement_api_v1_statements__post", "requestBody": { "content": { "application/json": { "examples": { "correct-statement": { "summary": "Create a statement for account id", "value": { "data": { "attributes": { "account_id": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2", "actual_monthly_payment": 0, "amount_past_due": 0, "credit_limit": 252, "current_balance": 0, "days_delinquent": 0, "last_payment_date": "2022-04-22", "scheduled_monthly_payment": 0, "statement_date": "2023-08-12", "statement_identifier": "d200c9a8-ea4b-4299-a9da-3e50313d3911" }, "type": "StatementCreate" } } } }, "schema": { "$ref": "#/components/schemas/Request_StatementCreate_" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Statement_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "Bad Request ": { "value": { "errors": [ { "detail": "Not able to create a statement the account status is 'Short Sale'", "status": 536, "title": "Operation not allowed" } ] } } }, "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Bad Request " }, "404": { "content": { "application/json": { "examples": { "Not Found ": { "value": { "errors": [ { "detail": "An error occurred in the request", "status": 510, "title": "Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Not Found " }, "409": { "content": { "application/json": { "examples": { "Conflict detected from request. ": { "value": { "errors": [ { "detail": "Statement with id '' and statement date '' (existing id: 'existing_statement_id')", "status": 581, "title": "Associated relationship id already exists" } ] } } }, "schema": { "$ref": "#/components/schemas/JSONAPIErrorResponse" } } }, "description": "Conflict detected from request. " }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "Oauth2ClientCredentials": [ "furnishment:all" ] } ], "summary": "Create Statement", "tags": [ "Statements" ] } } }, "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" } ] } ```