> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a document > Update attributes of the latest document version. ## OpenAPI ````yaml openapi.json patch /documents/{document_id} openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.208.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /documents/{document_id}: summary: Document patch: tags: - Documents summary: Update a document description: Update attributes of the latest document version. operationId: updateDocument parameters: - $ref: '#/components/parameters/document_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/document_patch' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/document_response' description: Updated document properties. '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '500': $ref: '#/components/responses/internal_server_error' components: parameters: document_id: description: The unique identifier of the document. in: path name: document_id required: true schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string schemas: document_patch: properties: batch_id: description: The ID of the batch that the document belongs to type: string deletion_reason: $ref: '#/components/schemas/document_deletion_reason' description: description: A description of the document type: string name: description: A user-friendly name for the document type: string type: $ref: '#/components/schemas/document_type' type: object document_response: properties: available_versions: $ref: '#/components/schemas/document_versions' available_versions_info: $ref: '#/components/schemas/document_versions_info' batch_id: description: The ID of the batch that the document belongs to type: string creation_time: description: The date and time the resource was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string deletion_reason: $ref: '#/components/schemas/document_deletion_reason' description: description: A description of the document type: string encryption: $ref: '#/components/schemas/document_encryption' file_name: description: The file name of the document readOnly: true type: string id: description: The unique identifier for this resource example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid readOnly: true type: string last_updated_time: description: The date and time the resource was last updated example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string metadata: $ref: '#/components/schemas/metadata' name: description: A user-friendly name for the document type: string related_resource_id: description: The ID of the resource related to the document format: uuid type: string related_resource_type: $ref: '#/components/schemas/related_resource_type' tenant: $ref: '#/components/schemas/tenant_id' type: $ref: '#/components/schemas/document_type' version: $ref: '#/components/schemas/document_version' type: object document_deletion_reason: description: >- An explanation why the file was deleted. You must set a document's deletion_reason before deleting it. type: string document_type: description: > The type of the document. The type can be changed after the document is created, except that a non-encrypted document cannot be changed to a type that requires encryption. enum: - ADDRESS_VERIFICATION - APPLICATION_DOCUMENTATION - BILLING_DOCUMENT - CHECK_IMAGE - COMPANY_PROFILE_DOCUMENT - COMPLIANCE_REPORT - DATE_OF_BIRTH_VERIFICATION - FINANCIAL_FILE - IDENTITY_DOCUMENTATION - INCOME_DOCUMENTATION - STATEMENT - STATEMENT_DISCLOSURE - TAX_FORM - TERMS_OF_SERVICE type: string document_versions: description: All document versions items: type: integer type: array document_versions_info: description: Metadata of all document versions items: $ref: '#/components/schemas/document_version_info' type: array document_encryption: description: > Whether the file will be encrypted by the Synctera platform before storing. All documents containing PII must be encrypted. Creating and retrieving encrypted documents requires documents_encrypted:write and documents_encrypted:read permissions, respectively. If encryption is not specified, a default will be chosen based on the document type. See the following table. Document types with a default of REQUIRED must be encrypted. It is an error to explicitly set encryption to NOT_REQUIRED for these document types. Document types with a default of NOT_REQUIRED may optionally be encrypted by explicitly setting encryption to REQUIRED. | Document Type | Default Encryption | |---------------|---------------------| | ADDRESS_VERIFICATION | REQUIRED | | APPLICATION_DOCUMENTATION | NOT_REQUIRED | | BILLING_DOCUMENT | NOT_REQUIRED | | CHECK_IMAGE | REQUIRED | | COMPANY_PROFILE_DOCUMENT | NOT_REQUIRED | | COMPLIANCE_REPORT | REQUIRED | | DATE_OF_BIRTH_VERIFICATION | REQUIRED | | FINANCIAL_FILE | REQUIRED | | IDENTITY_DOCUMENTATION | REQUIRED | | INCOME_DOCUMENTATION | REQUIRED | | STATEMENT | NOT_REQUIRED | | STATEMENT_DISCLOSURE | NOT_REQUIRED | | TAX_FORM | REQUIRED | | TERMS_OF_SERVICE | NOT_REQUIRED | enum: - NOT_REQUIRED - REQUIRED type: string metadata: description: > Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. type: object related_resource_type: description: The type of the resource related to the document enum: - ACCOUNT - BUSINESS - CUSTOMER - EDD - INVOICE - REVENUE_STATEMENT type: string tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string document_version: description: Positive integer representing the version of the document type: integer error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object document_version_info: properties: creation_time: description: The date and time the resource was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string file_name: description: The file name of the document readOnly: true type: string last_updated_time: description: The date and time the resource was last updated example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string version: $ref: '#/components/schemas/document_version' type: object responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error not_found: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Resource not found internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````