--- updatedAt: 2026-08-14T09:11:24.000Z agentTools: projectIndex: https://devportal.fintensy.com/llms.txt --- # Get bundle status by GUID This endpoint returns the signature status of the documents in a bundle identified by its unique GUID # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Digital Signature API", "description": "API definition for the Digital Signature services exposed by Fintensy and consumed by Record Credits.", "version": "1.0.0", "contact": { "name": "Fintensy API Team", "url": "https://www.fintensy.com" } }, "servers": [ { "url": "https://{{base_url}}", "description": "ACC – Application service (DEV)" }, { "url": "https://record-identity-dev.digitalisedsvices.com", "description": "ACC – Identity service (DEV)" }, { "url": "https://record-platform-dev.digitalisedsvices.com", "description": "ACC – Platform service (DEV)" }, { "url": "https://record-app.digitalisedsvices.com", "description": "PRD – Application service" }, { "url": "https://record-identity.digitalisedsvices.com", "description": "PRD – Identity service" }, { "url": "https://record-platform.digitalisedsvices.com", "description": "PRD – Platform service" } ], "paths": { "/api/bundles/{guid}/status": { "get": { "description": "This endpoint returns the signature status of the documents in a bundle identified by its unique GUID", "operationId": "get_apibundle{reference}status-1", "responses": { "200": { "description": "Successfully returns the bundle object with each document status", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "reference": "E080898", "bundle_id": "15bbc1c6-633b-4128-8cc9-d85e4048f5c0", "external_reference_id": "30dd879c-ee2f-11db-8314-0800200c9a66", "loan_contracts": { "status": "PartiallySigned", "package_id": "d50f245e-1234-4a8d-ae6f-98d33bc1234", "signers": [ { "email": "john.doe@example.com", "first_name": "John", "last_name": "Doe", "role": "1", "status": "Signed", "signed_at": "2025-07-04T11:04:23.000Z", "used_signing_method": "itsme", "choices": [ { "id": "accept_privacy_policy", "selected": true, "updated_at": "2025-07-04T11:03:00.000Z" }, { "id": "paper_credit_communications", "selected": false, "updated_at": "2025-07-04T11:03:05.000Z" }, { "id": "accept_secci", "selected": true, "updated_at": "2025-07-04T11:03:10.000Z" }, { "id": "accept_terms_and_conditions", "selected": true, "updated_at": "2025-07-04T11:03:15.000Z" }, { "id": "personal_data_processing_policy_acceptance", "selected": true, "updated_at": "2025-07-04T11:03:20.000Z" }, { "id": "life_insurance", "selected": true, "updated_at": "2025-07-04T11:03:25.000Z" } ] }, { "email": "agent.bond@example.com", "first_name": "Agent", "last_name": "Bond", "role": "3", "status": "ToSign", "signed_at": null, "used_signing_method": null, "choices": [] } ] }, "delivery_confirmation": { "status": "PartiallySigned", "package_id": "4a8d245e-1234-ae6f-ae6f-9cb33bcd7a01", "object_received": "false", "delivery_waiting_payment": "true", "signers": [ { "email": "john.doe@example.com", "first_name": "John", "last_name": "Doe", "role": "1", "status": "Signed", "signed_at": "2025-07-04T11:04:23.000Z", "used_signing_method": "itsme", "choices": [ { "id": "received_item", "selected": false, "updated_at": "2025-07-04T11:02:00.000Z" }, { "id": "ready_for_delivery", "selected": true, "updated_at": "2025-07-04T11:02:00.000Z" } ] }, { "email": "agent.bond@example.com", "first_name": "Agent", "last_name": "Bond", "role": "3", "status": "ToSign", "signed_at": null, "used_signing_method": null, "choices": [] } ] } } } }, "schema": { "type": "object", "properties": { "reference": { "type": "string", "default": "" }, "bundle_id": { "type": "string", "description": "Unique bundle guid on Fintensy side" }, "external_reference_id": { "type": "string", "description": "External reference identifier of the bundle provided by the integration side and propagated unchanged across bundle-related endpoints. Example: 30dd879c-ee2f-11db-8314-0800200c9a66" }, "loan_contracts": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "New", "Ready", "ToSign", "PartiallySigned", "Signed", "Archived", "Error" ], "default": "New", "description": "Status of the loan contract" }, "package_id": { "type": "string", "default": "", "description": "ID of the package to sign (shared with Nitro)" }, "signers": { "type": "object", "properties": { "email": { "type": "string", "default": "", "description": "Email address of the signer." }, "first_name": { "type": "string", "default": "", "description": "Signer’s first name." }, "last_name": { "type": "string", "description": "Signer’s last name" }, "role": { "type": "number", "description": "Role of the signer within the bundle. Example: Unknown = 0, Primary = 1, Secondary = 2, Broker = 3", "enum": [ 0, 1, 2, 3 ] }, "status": { "type": "string", "enum": [ "New", "ToSign", "Signed", "Archived", "Error", "Ready" ], "default": "New", "description": "Status of the signer for the contract documents." }, "signed_at": { "type": "string", "format": "date-time", "description": "Timestamp at which the bundle was signed by the signer", "default": "" }, "used_signing_method": { "type": "string", "default": "itsme", "enum": [ "itsme", "beid" ], "description": "Signing method used by the signer" }, "choices": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Unique and stable identifier of the choice. Example: accept_privacy_policy" }, "selected": { "type": "boolean", "description": "Signer's selection for the choice. true if selected, false if explicitly not selected, or null if no choice has been recorded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the choice was recorded. null if no choice has been recorded. Example: 2025-07-04T11:03:00.000Z" } }, "type": "object", "required": [ "id", "selected", "updated_at" ] }, "description": "Unique and stable identifier of the choice. \n\nPossible values depend on the document type: accept_privacy_policy, legal_notice, life_insurance, paper_credit_communications, accept_secci, accept_terms_and_conditions, personal_data_processing_policy_acceptance, energy_saving, electrical_vehicle, zero_emission_vehicle, decline_marketing, received_item, ready_for_delivery" } }, "required": [ "email", "first_name", "last_name", "role", "status", "signed_at", "used_signing_method" ], "description": "Information about the signers" } }, "required": [ "signers", "status", "package_id" ], "description": "Information regarding the loan contracts" }, "delivery_confirmation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "New", "Ready", "ToSign", "PartiallySigned", "Signed", "Archived", "Error" ], "description": "Status of the delivery atttest" }, "package_id": { "type": "string", "default": "", "description": "ID of the package to sign (shared with Nitro)" }, "object_received": { "type": "boolean", "default": "", "description": "Contains the value of the checkbox “Have received the financed item”" }, "delivery_waiting_payment": { "type": "boolean", "default": "", "description": "Contains the value of the checkbox \"That the item is at your disposal\"" }, "signers": { "type": "object", "properties": { "email": { "type": "string", "default": "", "description": "Email address of the signer." }, "first_name": { "type": "string", "description": "Signer’s first name.", "default": "" }, "last_name": { "type": "string", "default": "", "description": "Signer’s last name" }, "role": { "type": "number", "default": "", "description": "Role of the signer within the bundle. Example: Unknown = 0, Primary = 1, Secondary = 2, Broker = 3", "enum": [ 0, 1, 2, 3 ] }, "status": { "type": "string", "enum": [ "New", "Ready", "ToSign", "PartiallySigned", "Signed", "Archived", "Error" ], "default": "New", "description": "Status of the signer for the delivery attest." }, "signed_at": { "type": "string", "format": "date-time", "default": "", "description": "Timestamp at which the bundle was signed by the signer" }, "used_signing_method": { "type": "string", "default": "itsme", "enum": [ "itsme", "beid" ], "description": "Signing method used by the signer" }, "choices": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Unique and stable identifier of the choice. Example: accept_privacy_policy" }, "selected": { "type": "boolean", "description": "Signer's selection for the choice. true if selected, false if explicitly not selected, or null if no choice has been recorded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the choice was recorded. null if no choice has been recorded. Example: 2025-07-04T11:03:00.000Z" } }, "type": "object", "required": [ "id", "selected", "updated_at" ] }, "description": "Unique and stable identifier of the choice. \n\nPossible values depend on the document type: accept_privacy_policy, legal_notice, life_insurance, paper_credit_communications, accept_secci, accept_terms_and_conditions, personal_data_processing_policy_acceptance, energy_saving, electrical_vehicle, zero_emission_vehicle, decline_marketing, received_item, ready_for_delivery" } }, "required": [ "email", "first_name", "last_name", "role", "status", "signed_at", "used_signing_method" ], "description": "Information about the signers" } }, "required": [ "status", "package_id", "signers", "object_received", "delivery_waiting_payment" ], "description": "Information regarding the delivery attest" } }, "required": [ "loan_contracts", "reference", "bundle_id", "external_reference_id" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "number", "description": "Internal functional error code returned." }, "message": { "type": "string", "description": "Error message in plain text" }, "errors": { "type": "object", "description": "Error details object" } }, "required": [ "code", "message", "errors" ] } } } }, "401": { "description": "Unauthorized", "content": {} }, "404": { "description": "Not Found", "content": {} }, "500": { "description": "Internal Server Error", "content": {} } }, "parameters": [ { "in": "path", "name": "guid", "schema": { "type": "string" }, "required": true, "description": "bundle {guid} must be an existing identifier." } ], "x-readme": { "code-samples": [ { "code": "", "language": "json", "name": "" } ], "samples-languages": [ "json" ] }, "summary": "Get bundle status by GUID", "x-internal": false } } }, "security": [], "x-readme": {} } ```