{"openapi":"3.0.0","info":{"title":"Kompliant Web API","description":"The Kompliant Web API provides a robust platform for integrating compliance services into your applications.\nOur APIs enable businesses to manage the entire compliance lifecycle - from application processing to ongoing\nmonitoring and decision defense.\n","version":"2025-03-24","contact":{"url":"https://www.kompliant.com/"},"license":{"name":"Proprietary - For Authorized Use Only","url":"https://www.kompliant.com/terms-conditions"}},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"samples-languages":["http","shell","go","python","node","java"],"headers":[{"key":"X-API-Version","value":"2025-03-24"}]},"servers":[{"url":"https://api.kompliant.com","description":"Production server"}],"security":[{"kompliantSignatureAuth":[],"kompliantApiKey":[],"kompliantAuthToken":[]}],"tags":[{"name":"Account","description":"Operations for managing partner accounts and configuration"},{"name":"Bank Account","description":"Operations for managing bank account entities"},{"name":"Business","description":"Operations for managing business entities and their relationships"},{"name":"Document","description":"Operations for managing documents and document files"},{"name":"Fulfillment","description":"Operations for managing document fulfillments and comments"},{"name":"Location","description":"Operations for managing location entities"},{"name":"Metadata","description":"Operations for managing Metadata definitions and details"},{"name":"Person","description":"Operations for managing person entities"},{"name":"Required Document","description":"Operations for managing required documents within workflows"},{"name":"Subject Record","description":"Operations for managing subject records - containers for related entity information"},{"name":"Webhook","description":"Operations for managing webhook encryption keys and secure payload delivery"},{"name":"Workflow","description":"Operations for managing workflows that process data in a subject record"},{"name":"Account Provisioning","description":"Operations for managing account provisioning workflows and related entities"}],"components":{"securitySchemes":{"kompliantSignatureAuth":{"type":"apiKey","description":"Kompliant Signature Version 1 (KSig1) authentication - Authorization header.\nFormat: KSig1-HMAC-SHA256 <signature>\nPart of the KSig1 authentication that requires all three headers:\nAuthorization, X-API-Key, and X-API-Auth-Token.\n\nSee authentication documentation for details on the signature generation process.\n","name":"Authorization","in":"header"},"kompliantApiKey":{"type":"apiKey","description":"Kompliant Signature Version 1 (KSig1) authentication - API Key header.\nYour Kompliant API Key provided during onboarding.\nRequired for all API requests.\n","name":"X-API-Key","in":"header"},"kompliantAuthToken":{"type":"apiKey","description":"Kompliant Signature Version 1 (KSig1) authentication - Auth Token header.\nA valid authentication token obtained through the token endpoint.\nRequired for all authenticated API requests.\n","name":"X-API-Auth-Token","in":"header"}},"responses":{"Error401":{"description":"Unauthorized - Authentication errors or failures","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error401"}}}}]}}}},"Error403":{"description":"Forbidden - Authorization failures","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error403"}}}}]}}}},"Error4XX":{"description":"Other 400 level errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error4XX"}}}}]}}}},"Error5XX":{"description":"Server Error - Server-side issues","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error5XX"}}}}]}}}},"AccountDocumentTypeListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseTemplate"},"examples":{"validationError":{"summary":"Validation error with field-level details","value":{"meta":{"status":"ERROR","trace_id":"trc_6OI5blm21ZoSlq0PC3RqJV","version":"2025-03-24"},"errors":[{"code":"BAD_REQUEST","message":"Invalid request payload.","details":[{"path":"account_id","message":"account_id is required."},{"path":"status","message":"must be one of: [\"INACTIVE\",\"ACTIVE\"]"}]}]}}}}}},"BankAccountCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BankAccountDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BankAccountGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BankAccountListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BankAccountUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessAddBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessAddOwnerErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"message":{"type":"string","description":"Error message"},"entity_type":{"type":"string","description":"Type of entity for system rule or account configuration violations","enum":["Business","BusinessOwner","SubjectRecord"]},"sub_code":{"type":"string","description":"Additional error code violations, only present when code is SYSTEM_RULE_VIOLATION or ACCOUNT_CONFIGURATION_VIOLATION","enum":["CONTROL_PRONG_AGE_REQUIREMENT","CROSS_SUBJECT_RECORD_REFERENCE","DUPLICATE_OWNER_ASSOCIATION","MAX_OWNER_LIMIT","MINIMUM_OWNERSHIP_PERCENTAGE","OWNERSHIP_DATE_BEFORE_BIRTH_DATE","OWNERSHIP_DATE_BEFORE_ESTABLISHED","OWNERSHIP_PERCENTAGE_EXCEEDS_MAXIMUM","SINGLE_CONTROL_PRONG","SOLE_PROPRIETORSHIP_OWNERSHIP_PERCENTAGE","SOLE_PROPRIETORSHIP_OWNERSHIP_TYPE"]}}}}}}]}}}},"BusinessGetOwnerErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessUpdateOwnerErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"message":{"type":"string","description":"Error message"},"entity_type":{"type":"string","description":"Type of entity for system rule or account configuration violations.","enum":["Business","BusinessOwner"]},"sub_code":{"type":"string","description":"Additional error violations, only present when code is SYSTEM_RULE_VIOLATION or ACCOUNT_CONFIGURATION_VIOLATION","enum":["CONTROL_PRONG_AGE_REQUIREMENT","MINIMUM_OWNERSHIP_PERCENTAGE","OWNERSHIP_DATE_BEFORE_BIRTH_DATE","OWNERSHIP_DATE_BEFORE_ESTABLISHED","OWNERSHIP_PERCENTAGE_EXCEEDS_MAXIMUM","SINGLE_CONTROL_PRONG","SOLE_PROPRIETORSHIP_OWNERSHIP_PERCENTAGE","SOLE_PROPRIETORSHIP_OWNERSHIP_TYPE"]}}}}}}]}}}},"BusinessCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"message":{"type":"string","description":"Error message"},"entity_type":{"type":"string","description":"Type of entity for system rule or account configuration violations","enum":["Business"]},"sub_code":{"type":"string","description":"Additional error code violations. Only present when code is SYSTEM_RULE_VIOLATION","enum":["SOLE_PROPRIETORSHIP_OWNERSHIP_TYPE","SOLE_PROPRIETORSHIP_OWNERSHIP_PERCENTAGE","ESTABLISHED_DATE_AFTER_OWNERSHIP"]}}}}}}]}}}},"BusinessDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessListBankAccountsErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessGetBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessListOwnersErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessUpdateBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessRemoveBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessRemoveOwnerErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessAddLocationErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessGetLocationErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessListLocationsErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessRemoveLocationErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessSalesInfoCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"BusinessSalesInfoDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessSalesInfoGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"BusinessSalesInfoUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"DocumentCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseTemplate"},"examples":{"validationError":{"summary":"Multiple field validation errors","value":{"meta":{"status":"ERROR","trace_id":"trc_abc123xyz","version":"2025-03-24"},"errors":[{"code":"BAD_REQUEST","message":"Invalid request payload.","details":[{"path":"subject_record_id","message":"subject_record_id is required."},{"path":"file_name","message":"file_name is required."},{"path":"file_size_in_bytes","message":"file_size_in_bytes is required."}]}]}}}}}},"DocumentListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseTemplate"},"examples":{"validationError":{"summary":"ID validation error","value":{"meta":{"status":"ERROR","trace_id":"trc_def456uvw","version":"2025-03-24"},"errors":[{"code":"BAD_REQUEST","message":"Invalid request payload.","details":[{"path":"subject_record_id","message":"subject_record_id is not a valid ID."}]}]}}}}}},"DocumentGetDownloadErrorResponse":{"description":"Bad Request - Client request errors or document not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"DocumentGetErrorResponse":{"description":"Bad Request - Client request errors or document not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"DocumentDeleteErrorResponse":{"description":"Bad Request - Client request errors, linked entity, or document not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND"]}}}}}}]}}}},"LocationCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationAddBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ACCOUNT_CONFIGURATION_VIOLATION","BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"LocationGetBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationListBankAccountsErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"LocationRemoveBankAccountErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"MetadataTypeDefineErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseTemplate"},"examples":{"validationError":{"summary":"Metadata type define validation errors","value":{"meta":{"status":"ERROR","trace_id":"trc_metadata123","version":"2025-03-24"},"errors":[{"code":"BAD_REQUEST","message":"Invalid request params","details":[{"path":"fields.ip_address_v4.format","message":"format must be one of [ipv4, ipv6]"},{"path":"max_count","message":"must be -1 or a positive integer"}]}]}}}}}},"MetadataCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"MetadataUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MetadataGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MetadataListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PersonCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"PersonUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"PersonDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"PersonGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PersonListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PersonIssuedIdentifierCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"PersonIssuedIdentifierGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PersonIssuedIdentifierListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PersonIssuedIdentifierUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"PersonIssuedIdentifierDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"SubjectRecordCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"SubjectRecordDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_LINKED","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowUpdateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","ACCOUNT_CONFIGURATION_VIOLATION"]},"sub_code":{"type":"string","enum":["INVALID_WORKFLOW_TYPE","WORKFLOW_STARTED","WORKFLOW_ENDED","DUPLICATE_EMAIL"]}}}}}}]}}}},"WorkflowPricingCalculateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","MISSING_REQUIREMENTS","SYSTEM_RULE_VIOLATION","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"WorkflowPricingGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","ACCOUNT_CONFIGURATION_VIOLATION"]}}}}}}]}}}},"WorkflowStartErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowCanCompleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowCompleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","MISSING_REQUIREMENTS","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowDeleteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowRequiredDocumentCalculateErrorResponse":{"description":"Bad Request - Client request errors or validation failures for calculation","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","MISSING_REQUIREMENTS","ACCOUNT_CONFIGURATION_VIOLATION"]},"sub_code":{"type":"string","enum":["WORKFLOW_ENDED","MISSING_DOCUMENT_TYPES"],"description":"Sub-code providing additional context for certain error codes"},"entity_type":{"type":"string","description":"Type of entity related to the error (e.g., RequiredDocument, AccountDocumentType)"},"details":{"type":"array","description":"Array of detailed error information for MISSING_REQUIREMENTS errors","items":{"type":"object","required":["code","entity_type","message"],"properties":{"code":{"$ref":"#/components/schemas/MissingRequirements"},"entity_type":{"$ref":"#/components/schemas/EntityTypes"},"entity_id":{"type":"string","nullable":true,"description":"ID of the specific entity that has missing requirements"},"message":{"type":"string","description":"Human-readable description of the missing requirement"},"related_endpoints":{"type":"array","nullable":true,"description":"API endpoints that can be used to resolve the requirement","items":{"type":"string"}},"fields":{"type":"array","nullable":true,"description":"List of missing or invalid fields","items":{"type":"string"}}}}}}}}}}]}}}},"WorkflowRequiredDocumentBatchAddErrorResponse":{"description":"Bad Request - Client request errors or validation failures for batch add","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentBatchRequestDocumentErrorResponse":{"description":"Bad Request - Client request errors or validation failures for batch request document","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]},"message":{"type":"string","description":"Error message describing the validation failure","example":"Cannot request files for an inactive required document."}}}}}}]}}}},"WorkflowRequiredDocumentFulfillmentBatchAddErrorResponse":{"description":"Bad Request - Client request errors or validation failures for fulfillment batch add","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentFulfillmentListErrorResponse":{"description":"Bad Request - Client request errors or validation failures for fulfillment list","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentFulfillmentUpdateErrorResponse":{"description":"Bad Request - Client request errors or validation failures for fulfillment update","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentFulfillmentDeleteErrorResponse":{"description":"Bad Request - Client request errors or validation failures for fulfillment delete","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentFulfillmentAddCommentErrorResponse":{"description":"Bad Request - Client request errors or validation failures for fulfillment add comment","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentEventsListErrorResponse":{"description":"Bad Request - Client request errors or validation failures for workflow events list","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentDocumentRequestListErrorResponse":{"description":"Bad Request - Client request errors or validation failures for workflow events list","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]}}}}}}]}}}},"WorkflowRequiredDocumentEventListNotFoundErrorResponse":{"description":"Not Found - Fulfillment not found when filtering by fulfillment_id","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["ENTITY_NOT_FOUND"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"fulfillment_id":{"type":"string"}}}}}}}}}]}}}},"WorkflowAgreementListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowAgreementGetDownloadErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowApplicationSummaryGetDownloadErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","SYSTEM_ERROR"]},"sub_code":{"type":"string","enum":["INVALID_WORKFLOW_TYPE","WORKFLOW_NOT_ENDED","APPLICATION_SUMMARY_NOT_FOUND","APPLICATION_SUMMARY_IN_PROGRESS","APPLICATION_SUMMARY_FAILED"]}}}}}}]}}}},"WorkflowUnderwritingDecisionListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WorkflowUnderwritingDecisionGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"SubjectRecordListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MbtrustCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MbtrustCanExecuteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MbtrustExecuteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MbtrustGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MetadataLinksAddErrorResponse":{"description":"Bad Request - Client request errors, entity not found, or cross subject record reference","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","CROSS_SUBJECT_RECORD_REFERENCE"]}}}}}}]}}}},"MetadataLinksGetErrorResponse":{"description":"Bad Request - Client request errors, entity not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"MetadataLinksRemoveErrorResponse":{"description":"Bad Request - Client request errors, entity not found, or cross subject record reference","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","CROSS_SUBJECT_RECORD_REFERENCE"]}}}}}}]}}}},"WebhookKeyCreateErrorResponse":{"description":"Bad Request - Client request errors or system rule violations","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"sub_code":{"type":"string","description":"Additional error code for system rule violations","enum":["DAILY_LIMIT_EXCEEDED"]},"entity_type":{"type":"string","description":"Type of entity related to the error"}}}}}}]}}}},"WebhookKeyGetErrorResponse":{"description":"Bad Request - Client request errors or entity not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WebhookKeyActivateErrorResponse":{"description":"Bad Request - Client request errors or system rule violations","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"sub_code":{"type":"string","description":"Additional error code for system rule violations","enum":["KEY_ALREADY_ACTIVE","KEY_DELETED"]},"entity_type":{"type":"string","description":"Type of entity related to the error"}}}}}}]}}}},"WebhookConfigCreateErrorResponse":{"description":"Bad Request - Client request errors or system rule violations","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","SYSTEM_RULE_VIOLATION"]},"sub_code":{"type":"string","description":"Additional error code for system rule violations","enum":["MAX_WEBHOOK_URL_LIMIT_EXCEEDED","URL_ALREADY_EXISTS"]},"entity_type":{"type":"string","description":"Type of entity related to the error"}}}}}}]}}}},"WebhookConfigGetErrorResponse":{"description":"Bad Request - Client request errors or entity not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"WebhookConfigUpdateErrorResponse":{"description":"Bad Request - Client request errors, entity not found, or system rule violations","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION"]},"sub_code":{"type":"string","description":"Additional error code for system rule violations","enum":["URL_ALREADY_EXISTS"]},"entity_type":{"type":"string","description":"Type of entity related to the error"}}}}}}]}}}},"WebhookConfigListErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST"]}}}}}}]}}}},"WebhookConfigDeleteErrorResponse":{"description":"Bad Request - Client request errors or entity not found","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PropayCreateErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PropayCanExecuteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PropayExecuteErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}},"PropayGetErrorResponse":{"description":"Bad Request - Client request errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND"]}}}}}}]}}}}},"schemas":{"MetaSuccessResponse":{"type":"object","description":"Standard metadata included in all API responses","required":["status","trace_id","version"],"properties":{"status":{"type":"string","enum":["SUCCESS"],"description":"Status of the operation"},"trace_id":{"type":"string","description":"Trace ID for debugging"},"version":{"type":"string","description":"API version in YYYY-MM-DD format","example":"2025-03-24"}}},"MetaErrorResponse":{"type":"object","description":"Standard metadata included in all API responses","required":["status","trace_id","version"],"properties":{"status":{"type":"string","enum":["ERROR"],"description":"Status of the operation"},"trace_id":{"type":"string","description":"Trace ID for debugging"},"version":{"type":"string","description":"API version in YYYY-MM-DD format","example":"2025-03-24"}}},"MetaBatchProcessedResponse":{"type":"object","description":"Standard metadata included in batch API responses","required":["status","trace_id","version","total_requests","success_count","failure_count"],"properties":{"status":{"type":"string","enum":["BATCH_PROCESSED"],"description":"Status of the batch operation"},"trace_id":{"type":"string","description":"Trace ID for debugging"},"version":{"type":"string","description":"API version in YYYY-MM-DD format","example":"2025-03-24"},"total_requests":{"type":"integer","description":"Total number of requests in the batch"},"success_count":{"type":"integer","description":"Number of successful operations"},"failure_count":{"type":"integer","description":"Number of failed operations"},"warnings":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Warning message"}}},"description":"Optional warnings from the batch operation"}}},"ErrorResponseTemplate":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaErrorResponse"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorItem"}}}},"ErrorItem":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"sub_code":{"type":"string","nullable":true,"description":"Error sub-code providing additional context (e.g., WORKFLOW_ENDED)"},"entity_type":{"type":"string","nullable":true,"description":"The type of entity related to the error (e.g., Business, RequiredDocument)"},"message":{"type":"string","description":"Error message"},"details":{"type":"array","description":"Array of validation error details (only present for BAD_REQUEST validation errors)","items":{"$ref":"#/components/schemas/ValidationDetail"}}}},"ValidationDetail":{"type":"object","required":["path","message"],"description":"Detailed validation error information for a specific field","properties":{"path":{"type":"string","description":"The field path that failed validation (e.g., \"subject_record_id\", \"required_documents[0].document_type_code\")","example":"subject_record_id"},"message":{"type":"string","description":"Specific validation error message for this field","example":"subject_record_id is required."}}},"Error401":{"type":"object","description":"Standard error structure","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","enum":["AUTH_INVALID_HEADER","AUTH_INVALID_API_KEY","AUTH_INVALID_AUTH_TOKEN","AUTH_SIGNATURE_MISMATCH","AUTH_MISSING_HEADER"]},"message":{"type":"string","description":"Error message"}}},"Error403":{"type":"object","description":"Standard error structure","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","enum":["UNAUTHORIZED"]},"message":{"type":"string","description":"Error message"}}},"Error4XX":{"type":"object","description":"Standard error structure","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","enum":["INVALID_ENDPOINT_REQUEST","PAYLOAD_TOO_LARGE","THROTTLED","UNKNOWN_VERSION","UNSUPPORTED_MEDIA_TYPE"]},"message":{"type":"string","description":"Error message"}}},"Error5XX":{"type":"object","description":"Standard error structure","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","enum":["GATEWAY_TIMEOUT","INTERNAL_SERVER_ERROR","SERVICE_UNAVAILABLE"]},"message":{"type":"string","description":"Error message"}}},"BankAccountOwnershipTypes":{"type":"string","enum":["BUSINESS","INDIVIDUAL"],"description":"Bank Account Ownership Types indicates the type of entity that owns the bank account."},"BankAccountPurposes":{"type":"string","enum":["PRIMARY"],"description":"Bank Account Purposes indicates the purpose the bank account serves to the business."},"BankAccountTypes":{"type":"string","enum":["CHECKING","GENERAL_LEDGER","SAVINGS"],"description":"Bank Account Types indicates the type of bank account."},"BeneficialOwnershipType":{"type":"string","enum":["CONTROL_PRONG","OWNERSHIP_PRONG"],"description":"Beneficial Ownership Types indicate the type of ownership a person has over a business."},"BusinessAddressTypes":{"type":"string","enum":["LEGAL","MAILING"],"description":"Business Address Types indicate what type of address is being provided."},"BusinessPersonPositions":{"type":"string","enum":["ADMINISTRATOR","BOARD_MEMBER","DIRECTOR","EXECUTIVE_OFFICER","LEGAL_COUNSEL","MANAGER","OTHER","OWNER","PRESIDENT","STAFF_MEMBER"],"description":"Business Person Positions indicate what type of position within a business the person holds."},"BusinessRegistrationTypes":{"type":"string","enum":["CORPORATION_PRIVATE","CORPORATION_PUBLIC","GOVERNMENT","LLC_PRIVATE","LLC_PUBLIC","NON_PROFIT","SOLE_PROPRIETORSHIP","PARTNERSHIP_PRIVATE","PARTNERSHIP_PUBLIC"],"description":"Business Registration Types indicate the way a given business is registered."},"BusinessTransactionTypes":{"type":"string","enum":["INTERNET","LODGING","MOTO","RESTAURANT","RETAIL","RETAIL_W_TIP"],"description":"Business Transaction Types indicate the type of transactions the business engages in."},"CardBrands":{"type":"string","enum":["AMEX"],"description":"Card Brands indicate the brand of the card used for the transaction."},"Countries":{"type":"string","enum":["US"],"description":"Countries corresponds to the list of countries as found in the ISO 3166 list using alpha-2 country codes.","example":"US"},"Currencies":{"type":"string","enum":["USD"],"description":"Currencies corresponds to the list of currencies as found in the ISO 4217 list using alpha-3 currency codes.","example":"USD"},"EntityTypes":{"type":"string","enum":["BankAccount","Business","BusinessBankAccount","BusinessOwner","BusinessSalesInfo","Workflow"],"description":"Entity Types indicate the type of entity that is referenced in the system."},"IndustryCodeTypes":{"type":"string","enum":["MCC"],"description":"Industry Code Types indicates the type of industry code for which a value is being supplied."},"LocationTypes":{"type":"string","enum":["PROPERTY"],"description":"Location Types that define valid classification categories for locations."},"LocationOwnerTypes":{"type":"string","enum":["PROPERTY"],"description":"Location Owner Types that define valid ownership classifications for locations."},"LocationBankAccountPurposes":{"type":"string","enum":["SETTLEMENT","FEES"],"description":"Location Bank Account Purposes that define the purpose of bank accounts associated with locations."},"MccCardBrands":{"type":"string","enum":["MASTERCARD"],"description":"Card brands that define their own merchant category codes."},"MissingRequirements":{"type":"string","enum":["CALCULATED_PRICING_REQUIRED","CONTROL_PRONG_REQUIRED","FIELDS_REQUIRED","PRIMARY_BANK_ACCOUNT_REQUIRED","SALES_INFO_REQUIRED","STARTED_WORKFLOW_REQUIRED"],"description":"Missing Requirements indicate specific requirements that must be met for workflow completion."},"PersonAddressTypes":{"type":"string","enum":["PRIMARY_RESIDENCE"],"description":"Person Address Types indicate what type of address is being provided."},"PersonIssuedIdentifierTypes":{"type":"string","enum":["MEDICAL_LICENSE"],"description":"Person Issued Identifier Types indicate the type of government-issued identifier for a person."},"PricingTypes":{"type":"string","enum":["INTERCHANGE"],"description":"Pricing Types indicates the pricing type used when the method `workflow.pricing.calculate` is executed.\n\nAvailable Types:\n- `INTERCHANGE` - Interchange pricing calculated and managed by Kompliant\n- `<others>` - As defined in the account setup process\n"},"PricingItemTypes":{"type":"string","enum":["FIXED_AMOUNT","PERCENTAGE","PER_UNIT","CUSTOM_TEXT"],"description":"Pricing Item Type represents the value type of the pricing item.\n\nAvailable Types:\n- `FIXED_AMOUNT` - Pricing item of type FIXED_AMOUNT\n- `PERCENTAGE` - Pricing item of type PERCENTAGE\n- `PER_UNIT` - Pricing item of type PER_UNIT\n- `CUSTOM_TEXT` - Pricing item of type CUSTOM_TEXT\n"},"PricingItemCodes":{"type":"string","enum":["per_transaction_rate","blended_rate","amex_rate","international_surcharge_rate","credit_card_rate","debit_card_rate","international_rate","ach_per_transaction_rate","ach_disbursement_fee","ach_return_fee","chargeback_fee","maintenance_fee","no_payment_maintenance_fee","per_transaction_fee","application_fee","monthly_subscription_fee","annual_subscription_fee","internal_cost_per_transaction_fee","rate_cost","credit_card_per_transaction_fee","debit_card_per_transaction_fee","amex_per_transaction_fee","ach_per_transaction_fee","international_per_transaction_fee","payouts_per_transaction_fee","custom_pricing"],"description":"Pricing Item Codes represents the code of the pricing item.\n\nAvailable Codes:\n- `per_transaction_rate` - Per transaction rate\n- `blended_rate` - Blended rate for all card types\n- `amex_rate` - American Express rate\n- `international_surcharge_rate` - International transaction surcharge rate\n- `credit_card_rate` - Credit card transaction rate\n- `debit_card_rate` - Debit card transaction rate\n- `international_rate` - International transaction rate\n- `ach_per_transaction_rate` - ACH per transaction fee\n- `ach_disbursement_fee` - ACH disbursement fee\n- `ach_return_fee` - Fee for ACH returns\n- `chargeback_fee` - Fee for processing chargebacks\n- `maintenance_fee` - Monthly maintenance fee\n- `no_payment_maintenance_fee` - Maintenance fee when no payments processed\n- `per_transaction_fee` - Per transaction flat fee\n- `application_fee` - Application fee\n- `monthly_subscription_fee` - Monthly subscription fee\n- `annual_subscription_fee` - Annual subscription fee\n- `internal_cost_per_transaction_fee` - Internal cost per transaction\n- `rate_cost` - Rate cost (priced per unit/BPS)\n- `credit_card_per_transaction_fee` - Credit card per transaction fee\n- `debit_card_per_transaction_fee` - Debit card per transaction fee\n- `amex_per_transaction_fee` - American Express per transaction fee\n- `ach_per_transaction_fee` - ACH per transaction fee\n- `international_per_transaction_fee` - International per transaction fee\n- `payouts_per_transaction_fee` - Payouts per transaction fee\n- `custom_pricing` - Custom pricing arrangement\n"},"SalesAmountTypes":{"type":"string","enum":["AVERAGE_MONTHLY_CREDIT_SALES","AVERAGE_YEARLY_CREDIT_SALES","AVERAGE_INDIVIDUAL_SALE","HIGHEST_TICKET_SALE"],"description":"Sales Amount Types indicate the type of sales amount being reported."},"SocialNetworks":{"type":"string","enum":["FACEBOOK","INSTAGRAM","LINKEDIN","X","YOUTUBE"],"description":"Social Networks represents many of the commonly used social media sites on the internet."},"States":{"type":"string","description":"States corresponds to the list of United States states as found in the ISO 3166-2:US list.","example":"CA"},"SubjectRecordTypes":{"type":"string","enum":["BUSINESS"],"description":"Subject Record Types indicate the type of entity that is or can be stored in the Subject Record."},"WorkflowStates":{"type":"string","enum":["CREATED","STARTED","ENDED"],"description":"Workflow States indicate the state of Workflow."},"WorkflowTypes":{"type":"string","enum":["BUSINESS_APPLICATION","ACCOUNT_PROVISIONING"],"description":"Workflow Types indicate the type of workflow."},"WebhookKeyStatuses":{"type":"string","enum":["INACTIVE","ACTIVE","DELETED"],"description":"Webhook Key Statuses indicate the current state of a webhook encryption key.\n- `INACTIVE` - A key that has been created but not yet activated\n- `ACTIVE` - A key that is currently active and being used for encryption\n- `DELETED` - A key that has been deactivated and can no longer be used\n"},"RequiredDocumentStatuses":{"type":"string","enum":["INACTIVE","COMPLETED","NEEDS_REVIEW"],"description":"Required Document Statuses indicate the current status of a required document."},"FulfillmentDecisionStatuses":{"type":"string","enum":["NEEDS_REVIEW","IN_REVIEW","ACCEPTED","REJECTED"],"description":"Fulfillment Decision Statuses indicate the review status of a document fulfillment."},"DocumentUploadStatuses":{"type":"string","enum":["PENDING","COMPLETED","FAILED"],"description":"Document Upload Statuses indicate the completion status of a document upload."},"AccountProvisioningEntityStatuses":{"type":"string","enum":["CREATED","ACTIVE","CLOSED"],"description":"Account Provisioning Entity States indicate the state of the account provisioning entity."},"AccountProvisioningSponsors":{"type":"string","enum":["MERRICK","GLOBAL_PAYMENTS"],"description":"Account Provisioning Sponsors indicate the sponsors associated with the account provisioning entity."},"MbtrustMissingRequirements":{"type":"string","enum":["MERCHANT_NOT_ONBOARDED","MID_REQUIRED","NO_DOCUMENTS_REQUIRED","NO_DOCUMENTS_FOUND","MERCHANT_ID_NOT_MATCHING","BUSINESS_BANK_ACCOUNT_INFORMATION_REQUIRED","BUSINESS_OWNER_INFO_REQUIRED","BUSINESS_SALES_INFO_REQUIRED","FIELDS_REQUIRED","ACCOUNT_PROVISIONING_DISABLED","ACCOUNT_PROVISIONING_ONBOARDING_DISABLED","ACCOUNT_PROVISIONING_DOCUMENT_SYNC_DISABLED","ENTITY_REQUIRED","DOCUMENT_REQUIRED"],"description":"Missing Requirements indicate specific requirements that must be met for workflow completion."},"MbtrustEntityTypes":{"type":"string","enum":["Business","BankAccount","BusinessBankAccount","BusinessOwner","BusinessSalesInfo","Document"],"description":"Entity Types indicate the type of entity that is referenced in the system."},"PropayMissingRequirements":{"type":"string","enum":["BUSINESS_LEGAL_NAME_REQUIRED","BUSINESS_TAX_NUMBER_REQUIRED","MERCHANT_CATEGORY_CODE_REQUIRED","BUSINESS_REGISTRATION_TYPE_REQUIRED","INVALID_BUSINESS_REGISTRATION_TYPE","PRIMARY_ADDRESS_REQUIRED","PRIMARY_ADDRESS_LINE1_REQUIRED","PRIMARY_CITY_REQUIRED","PRIMARY_STATE_REQUIRED","PRIMARY_POSTAL_CODE_REQUIRED","BUSINESS_ADDRESS_REQUIRED","BUSINESS_ADDRESS_LINE1_REQUIRED","BUSINESS_CITY_REQUIRED","BUSINESS_STATE_REQUIRED","BUSINESS_POSTAL_CODE_REQUIRED","BUSINESS_OWNER_REQUIRED","OWNER_SSN_REQUIRED","OWNER_DOB_REQUIRED","OWNER_OWNERSHIP_PERCENTAGE_REQUIRED","BANK_ACCOUNT_REQUIRED","ROUTING_NUMBER_REQUIRED","ACCOUNT_NUMBER_REQUIRED","ACCOUNT_TYPE_REQUIRED","INVALID_ACCOUNT_OWNERSHIP_TYPE","INVALID_ACCOUNT_TYPE","SALES_DETAILS_REQUIRED","MONTHLY_VOLUME_REQUIRED","AVERAGE_TICKET_REQUIRED","HIGHEST_TICKET_REQUIRED","PROVISIONER_DISABLED","TIER_CODE_REQUIRED","FIELDS_REQUIRED","ACCOUNT_PROVISIONING_DISABLED","ACCOUNT_PROVISIONING_ONBOARDING_DISABLED","ACCOUNT_PROVISIONING_DOCUMENT_SYNC_DISABLED","ENTITY_REQUIRED"],"description":"Missing Requirements indicate specific requirements that must be met for workflow completion."},"PropayEntityTypes":{"type":"string","enum":["Business","BankAccount","BusinessBankAccount","BusinessOwner","BusinessSalesInfo","Document"],"description":"Entity Types indicate the type of entity that is referenced in the system."},"AccountProvisioningOperationStatuses":{"type":"string","enum":["PENDING","IN_PROGRESS","SUCCESS","FAILED"],"description":"Account Provisioning operation statuses indicate the state of the account provisioning operation."},"AccountProvisioningOperations":{"type":"string","enum":["ONBOARDING","DOCUMENT_SYNC"],"description":"Account provisioning operations that can be queued for processing."},"AccountProvisioningOperationResult":{"type":"object","required":["operation_id","operation_type","status"],"properties":{"operation_id":{"type":"string","description":"The ID of the operation processed."},"operation_type":{"description":"Type of the operation processed.","$ref":"#/components/schemas/AccountProvisioningOperations"},"status":{"$ref":"#/components/schemas/AccountProvisioningOperationStatuses","description":"Current status of the account provisioning operation."},"started_at":{"type":"string","format":"date-time","description":"The date-time when the operation was started in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"finished_at":{"type":"string","format":"date-time","description":"The date-time when the operation was finished in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"BaseAddress":{"type":"object","description":"Base address structure without type classification, reusable across entities","properties":{"line1":{"type":"string","nullable":true,"description":"First line of the address"},"line2":{"type":"string","nullable":true,"description":"Second line of the address (optional)"},"city":{"type":"string","nullable":true,"description":"City name"},"state":{"allOf":[{"$ref":"#/components/schemas/States"},{"type":"string","nullable":true}]},"postal_code":{"type":"string","nullable":true,"description":"Postal or ZIP code"},"country":{"allOf":[{"$ref":"#/components/schemas/Countries"},{"type":"string","nullable":true}]}}},"Address":{"allOf":[{"$ref":"#/components/schemas/BaseAddress"},{"type":"object","required":["type"],"description":"Common address structure used for both business and person addresses","properties":{"type":{"type":"string","description":"Type of address, varies by context (see specific implementations)"}}}]},"IndustryCategoryCode":{"type":"object","required":["type","code"],"description":"Industry classification code for the business","properties":{"type":{"$ref":"#/components/schemas/IndustryCodeTypes"},"code":{"type":"string","description":"The industry code value"},"details":{"type":"object","properties":{"mcc_details":{"type":"object","properties":{"card_brand":{"$ref":"#/components/schemas/MccCardBrands"}}}}}}},"PersonIssuedIdentifier":{"type":"object","description":"Summary information about a person's issued identifier","properties":{"issued_identifier_id":{"type":"string","description":"The ID of the Person Issued Identifier."},"type":{"$ref":"#/components/schemas/PersonIssuedIdentifierTypes"},"issued_number":{"type":"string","description":"The issued identifier number"},"person_id":{"type":"string","description":"The ID of the Person associated with this issued identifier."},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Person Issued Identifier was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Person Issued Identifier was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"SocialNetworkObject":{"type":"object","required":["network","url"],"description":"Represents a social media presence","properties":{"network":{"$ref":"#/components/schemas/SocialNetworks","description":"Type of social network"},"url":{"type":"string","description":"URL to the social media profile"}}},"Workflow":{"type":"object","description":"Summary information about a workflow","properties":{"workflow_id":{"type":"string","description":"The ID for the Workflow."},"type":{"$ref":"#/components/schemas/WorkflowTypes"},"subject_record_id":{"type":"string","description":"The Subject Record associated with the Workflow."},"state":{"$ref":"#/components/schemas/WorkflowStates"},"details":{"type":"object","description":"Details specific to the workflow type"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"Business":{"type":"object","description":"Summary information about a business","properties":{"business_id":{"type":"string","description":"The ID of the Business."},"sales_info_id":{"type":"string","nullable":true,"description":"The ID of the Sales Info entity if previously created."},"legal_name":{"type":"string","nullable":true,"description":"Legal name of the business"},"operating_name":{"type":"string","nullable":true,"description":"Operating or DBA name of the business"},"registration_type":{"$ref":"#/components/schemas/BusinessRegistrationTypes"},"tax_id":{"type":"string","description":"Tax identification number"},"phone_number":{"type":"string","description":"Contact phone number"},"industry_category_codes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCategoryCode"}},"established_date":{"type":"string","format":"date","description":"Date when the business was established"},"transaction_type":{"$ref":"#/components/schemas/BusinessTransactionTypes"},"business_description":{"type":"string","description":"Description of the business"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/BusinessAddressTypes"}}}]}},"social_networks":{"type":"array","items":{"$ref":"#/components/schemas/SocialNetworkObject"}},"website":{"type":"string","description":"Business website URL"},"additional_fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Name of the additional field"},"value":{"description":"Value of the additional field"}}}},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Business was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Business was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"BankAccount":{"type":"object","description":"Summary information about a bank account","properties":{"bank_account_id":{"type":"string","description":"The ID of the Bank Account."},"bank_account_ownership_type":{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},"bank_account_type":{"$ref":"#/components/schemas/BankAccountTypes"},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number"},"bank_name":{"type":"string","description":"Name of the bank"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Bank Account was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Bank Account was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"Location":{"type":"object","description":"Summary information about a location","properties":{"location_id":{"type":"string","description":"The ID of the Person."},"location_type":{"type":"string","description":"The type of Location."},"location_name":{"type":"string","description":"The name of a Location."},"owner_type":{"type":"string","description":"The type of owner for the location."},"owner_name":{"type":"string","description":"The name of the owner for the location."},"address":{"type":"object","description":"The address of the location.","$ref":"#/components/schemas/Address"},"location_bank_accounts":{"type":"array","description":"The bank accounts associated with the location (included only if verbose=true).","items":{"$ref":"#/components/schemas/LocationBankAccountBase"}},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Location was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Location was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"LocationBankAccountBase":{"type":"object","description":"Location bank account properties without sub entities: BankAccount","properties":{"location_bank_account_id":{"type":"string","description":"ID of the location-bank account relationship"},"bank_account_id":{"type":"string","description":"ID of the associated bank account"},"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/LocationBankAccountPurposes"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"LocationBankAccount":{"allOf":[{"$ref":"#/components/schemas/LocationBankAccountBase"},{"type":"object","properties":{"bank_account":{"$ref":"#/components/schemas/BankAccount","description":"Location bank account details (included when verbose=true)"}}}]},"Person":{"type":"object","description":"Summary information about a person","properties":{"person_id":{"type":"string","description":"The ID of the Person."},"email":{"type":"string","description":"The personal email address of the person."},"first_name":{"type":"string","description":"The legal first given name for the person."},"middle_name":{"type":"string","description":"The legal middle name for the person."},"last_name":{"type":"string","description":"The legal last name for the person."},"date_of_birth":{"type":"string","format":"date","description":"The legal date of birth for the person."},"tax_id":{"type":"string","description":"The tax ID for the person."},"citizenship":{"type":"string","description":"Two character code for the country of citizenship for the person."},"phone_number":{"type":"string","description":"The primary personal phone number of the person."},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]}},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Person was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Person was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}},"MetadataDetails":{"type":"object","description":"MetadataDetails Entity","properties":{"metadata_id":{"type":"string","format":"string","description":"ID of the MetadataDetail entity for which details are being retrieved","example":"md_17USYmUTu2cCOVi7HG4hoE"},"linked_entity_ids":{"type":"array","description":"Array of linked entity IDs associated with the metadata","items":{"type":"string"},"example":["p_3Dfcjs7de4BKSV65ambCQT","b_7KflBrVgWBrBBY5lirMQFr"]},"metadata_type_owner":{"type":"string","description":"Owner of the metadata type (Possible values areSYSTEM, ACCOUNT, INTERNAL)","example":"SYSTEM"},"metadata_type":{"type":"string","description":"Type of the metadata","example":"IP_ADDRESS"},"details":{"type":"object","description":"Key-value pairs for metadata details","additionalProperties":true,"example":{"ip_address":"192.168.1.1"}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the metadata was created","example":"2024-01-01T12:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the metadata was last updated","example":"2024-01-02T12:00:00Z"}}},"BankAccountCreateRequest":{"type":"object","required":["subject_record_id","bank_account"],"properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the subject record"},"bank_account":{"type":"object","required":["bank_routing_number","bank_account_number"],"properties":{"bank_account_ownership_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},{"type":"string","nullable":true}]},"bank_account_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountTypes"},{"type":"string","nullable":true}]},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number"},"bank_name":{"type":"string","nullable":true,"description":"Name of the bank"}}}}},"BankAccountCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"bank_account":{"type":"object","properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the newly created bank account entity"}}}}}}},"BankAccountDeleteRequest":{"type":"object","required":["bank_account_id"],"properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account to delete"}}},"BankAccountDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"BankAccountGetRequest":{"type":"object","required":["bank_account_id"],"properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"BankAccountGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"bank_account":{"type":"object","properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_ownership_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},{"type":"string","nullable":true}]},"bank_account_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountTypes"},{"type":"string","nullable":true}]},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number"},"bank_name":{"type":"string","nullable":true,"description":"Name of the bank"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was last updated"}}}}}}},"BankAccountListRequest":{"type":"object","required":["subject_record_id"],"properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record to list bank accounts for"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"BankAccountListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"bank_accounts":{"type":"array","items":{"type":"object","properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_ownership_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},{"type":"string","nullable":true}]},"bank_account_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountTypes"},{"type":"string","nullable":true}]},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number"},"bank_name":{"type":"string","nullable":true,"description":"Name of the bank"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was last updated"}}}}}}}},"BankAccountUpdateRequest":{"type":"object","required":["bank_account_id"],"properties":{"bank_account_id":{"type":"string","format":"string","description":"The ID of the Bank Account"},"bank_account":{"type":"object","properties":{"bank_account_ownership_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},{"type":"string","nullable":true}]},"bank_account_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountTypes"},{"type":"string","nullable":true}]},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number"},"bank_name":{"type":"string","nullable":true,"description":"Name of the bank"}}}}},"BankAccountUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"BusinessAddBankAccountRequest":{"type":"object","required":["business_id","business_bank_account"],"properties":{"business_id":{"type":"string","format":"string","description":"ID of the business entity"},"business_bank_account":{"type":"object","required":["bank_account_id"],"properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account to associate"},"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountPurposes"}}}}}},"BusinessAddBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_bank_account":{"type":"object","properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the newly created business-bank account relationship"}}}}}}},"BusinessAddOwnerRequest":{"type":"object","required":["business_id","business_owner"],"properties":{"business_id":{"type":"string","format":"string","description":"The ID of the business entity"},"business_owner":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","format":"string","description":"The ID of the person to add as an owner"},"ownership_type":{"allOf":[{"$ref":"#/components/schemas/BeneficialOwnershipType"},{"type":"string","nullable":true}]},"ownership_percentage":{"type":"number","nullable":true,"description":"Percentage of ownership (0-100)"},"ownership_year_month":{"type":"string","nullable":true,"description":"Year and month when ownership began (YYYY-MM format)"},"business_person_position":{"allOf":[{"$ref":"#/components/schemas/BusinessPersonPositions"},{"type":"string","nullable":true}]}}}}},"BusinessGetOwnerRequest":{"type":"object","required":["business_owner_id"],"properties":{"business_owner_id":{"type":"string","format":"string","description":"ID of the business owner to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response (defaults to false if not provided)"},"verbose":{"type":"boolean","description":"Whether to include the associated person entity in the response"}}},"BusinessGetOwnerResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_owner":{"type":"object","properties":{"business_owner_id":{"type":"string","format":"string","description":"The ID of the Business Owner"},"person_id":{"type":"string","format":"string","description":"The Person that is an owner of business"},"ownership_type":{"allOf":[{"$ref":"#/components/schemas/BeneficialOwnershipType"},{"type":"string","nullable":true}]},"ownership_percentage":{"type":"number","nullable":true,"description":"Percentage of ownership (0-100)"},"ownership_year_month":{"type":"string","nullable":true,"description":"Year and month when ownership began (YYYY-MM format)"},"business_person_position":{"allOf":[{"$ref":"#/components/schemas/BusinessPersonPositions"},{"type":"string","nullable":true}]},"person":{"type":"object","description":"Person entity information (only included when verbose=true)","properties":{"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]},"description":"Addresses of the person"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the person was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the person was last updated"}}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the business owner relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the business owner relationship was last updated"}}}}}}},"BusinessUpdateOwnerRequest":{"type":"object","required":["business_owner_id"],"properties":{"business_owner_id":{"type":"string","format":"string","description":"The ID of the business owner entity"},"business_owner":{"type":"object","properties":{"ownership_type":{"allOf":[{"$ref":"#/components/schemas/BeneficialOwnershipType"},{"type":"string","nullable":true}]},"ownership_percentage":{"type":"number","nullable":true,"description":"Percentage of ownership (0-100)"},"ownership_year_month":{"type":"string","nullable":true,"description":"Year and month when ownership began (YYYY-MM format)"},"business_person_position":{"allOf":[{"$ref":"#/components/schemas/BusinessPersonPositions"},{"type":"string","nullable":true}]}}}}},"BusinessAddOwnerResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_owner":{"type":"object","properties":{"business_owner_id":{"type":"string","format":"string","description":"ID of the newly created business-owner relationship"}}}}}}},"BusinessUpdateOwnerResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object"}}},"BusinessCreateRequest":{"type":"object","required":["subject_record_id","business"],"description":"Request to create a new business entity","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the subject record"},"business":{"type":"object","description":"Business entity details","properties":{"legal_name":{"type":"string","nullable":true,"description":"Legal name of the business"},"operating_name":{"type":"string","nullable":true,"description":"Operating or DBA name of the business"},"registration_type":{"allOf":[{"$ref":"#/components/schemas/BusinessRegistrationTypes"},{"type":"string","nullable":true}]},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"phone_number":{"type":"string","nullable":true,"description":"Contact phone number"},"email":{"type":"string","nullable":true,"description":"Email address of the business"},"industry_category_codes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCategoryCode"},"description":"Industry classification codes"},"established_date":{"type":"string","format":"date","nullable":true,"description":"Date when the business was established"},"transaction_type":{"allOf":[{"$ref":"#/components/schemas/BusinessTransactionTypes"},{"type":"string","nullable":true}]},"business_description":{"type":"string","nullable":true,"description":"Description of the business"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/BusinessAddressTypes"}}}]}},"social_networks":{"type":"array","items":{"$ref":"#/components/schemas/SocialNetworkObject"},"description":"Social media presences"},"website":{"type":"string","nullable":true,"description":"Business website URL"},"additional_fields":{"type":"array","items":{"type":"object","required":["field","value"],"properties":{"field":{"type":"string","description":"Name of the additional field"},"value":{"type":"string","description":"Value of the additional field"}}},"description":"Optional additional fields for custom business data (requires feature to be enabled)"}}}}},"BusinessCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business":{"type":"object","properties":{"business_id":{"type":"string","format":"string","description":"ID of the newly created business entity"}}}}}}},"BusinessUpdateRequest":{"type":"object","required":["business_id","business"],"description":"Request to update a business entity","properties":{"business_id":{"type":"string","format":"string","description":"The ID of the business"},"business":{"type":"object","description":"Business entity details","properties":{"legal_name":{"type":"string","nullable":true,"description":"Legal name of the business"},"operating_name":{"type":"string","nullable":true,"description":"Operating or DBA name of the business"},"registration_type":{"allOf":[{"$ref":"#/components/schemas/BusinessRegistrationTypes"},{"type":"string","nullable":true}]},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"phone_number":{"type":"string","nullable":true,"description":"Contact phone number"},"industry_category_codes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/IndustryCategoryCode"},"description":"Industry classification codes"},"established_date":{"type":"string","format":"date","nullable":true,"description":"Date when the business was established"},"transaction_type":{"allOf":[{"$ref":"#/components/schemas/BusinessTransactionTypes"},{"type":"string","nullable":true}]},"business_description":{"type":"string","nullable":true,"description":"Description of the business"},"addresses":{"type":"array","nullable":true,"items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/BusinessAddressTypes"}}}]}},"social_networks":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SocialNetworkObject"},"description":"Social media presences"},"website":{"type":"string","nullable":true,"description":"Business website URL"},"additional_fields":{"type":"array","items":{"type":"object","required":["field","value"],"properties":{"field":{"type":"string","description":"Name of the additional field"},"value":{"type":"string","nullable":true,"description":"Value of the additional field"}}},"description":"Optional additional fields for custom business data (requires feature to be enabled)"}}}}},"BusinessUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business":{"type":"object","properties":{"business_id":{"type":"string","format":"string","description":"ID of the updated business entity"}}}}}}},"BusinessDeleteRequest":{"type":"object","required":["business_id"],"properties":{"business_id":{"type":"string","format":"string","description":"ID of the business to delete"}}},"BusinessDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"BusinessGetRequest":{"type":"object","required":["business_id"],"properties":{"business_id":{"type":"string","format":"string","description":"ID of the business to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include related entities (business_bank_accounts, business_owners, sales_info) in the response"}}},"BusinessGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business":{"type":"object","properties":{"business_id":{"type":"string","format":"string","description":"ID of the business entity"},"sales_info_id":{"type":"string","format":"string","nullable":true,"description":"ID of the associated sales information"},"legal_name":{"type":"string","nullable":true,"description":"Legal name of the business"},"operating_name":{"type":"string","nullable":true,"description":"Operating or DBA name of the business"},"registration_type":{"type":"string","nullable":true,"description":"Type of business registration"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"phone_number":{"type":"string","nullable":true,"description":"Contact phone number"},"email":{"type":"string","nullable":true,"description":"Email address of the business"},"industry_category_codes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCategoryCode"},"description":"Industry classification codes"},"established_date":{"type":"string","format":"date","nullable":true,"description":"Date when the business was established"},"transaction_type":{"$ref":"#/components/schemas/BusinessTransactionTypes"},"business_description":{"type":"string","nullable":true,"description":"Description of the business"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/BusinessAddressTypes"}}}]},"description":"Business addresses"},"social_networks":{"type":"array","items":{"$ref":"#/components/schemas/SocialNetworkObject"},"description":"Social media presences"},"website":{"type":"string","nullable":true,"description":"Business website URL"},"additional_fields":{"type":"array","items":{"type":"object","required":["field","value"],"properties":{"field":{"type":"string","description":"Name of the additional field"},"value":{"type":"string","description":"Value of the additional field"}}},"description":"Additional custom fields for the business (requires feature to be enabled)"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the business was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the business was last updated"},"business_bank_accounts":{"type":"array","description":"Business bank accounts (only included when verbose=true)","items":{"type":"object","properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship"},"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_purposes":{"type":"string","description":"Purpose of the bank account"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"}}}},"business_owners":{"type":"array","description":"Business owners (only included when verbose=true)","items":{"type":"object","properties":{"business_owner_id":{"type":"string","format":"string","description":"ID of the business-owner relationship"},"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"ownership_type":{"allOf":[{"$ref":"#/components/schemas/BeneficialOwnershipType"},{"type":"string","nullable":true}]},"ownership_percentage":{"type":"number","nullable":true,"description":"Percentage of ownership (0-100)"},"ownership_year_month":{"type":"string","nullable":true,"description":"Year and month when ownership began (YYYY-MM format)"},"business_person_position":{"allOf":[{"$ref":"#/components/schemas/BusinessPersonPositions"},{"type":"string","nullable":true}]},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"}}}},"sales_info":{"type":"object","description":"Sales information (only included when verbose=true and sales_info_id is present)","nullable":true,"properties":{"sales_info_id":{"type":"string","format":"string","description":"Unique identifier for the sales information"},"card_brands":{"type":"array","description":"Accepted card brands","items":{"$ref":"#/components/schemas/CardBrands"}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the sales info was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the sales info was last updated"}}}}}}}}},"BusinessListBankAccountsRequest":{"type":"object","required":["business_id"],"properties":{"business_id":{"type":"string","format":"string","description":"ID of the business to list bank accounts for"},"verbose":{"type":"boolean","description":"Include nested bank account details in the response"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"BusinessListBankAccountsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_bank_accounts":{"type":"array","items":{"type":"object","properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship"},"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountPurposes"}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"},"bank_account":{"type":"object","description":"Nested bank account details (available when verbose=true)","properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_ownership_type":{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},"bank_account_type":{"$ref":"#/components/schemas/BankAccountTypes"},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number (redacted unless show_sensitive_data=true)"},"bank_name":{"type":"string","description":"Name of the bank"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was last updated"}}}}}}}}}},"BusinessGetBankAccountRequest":{"type":"object","required":["business_bank_account_id"],"properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include detailed bank account information"}}},"BusinessGetBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_bank_account":{"type":"object","properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship"},"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountPurposes"}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"},"bank_account":{"type":"object","description":"Detailed bank account information (only included when verbose=true)","properties":{"bank_account_id":{"type":"string","format":"string","description":"ID of the bank account entity"},"bank_account_ownership_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountOwnershipTypes"},{"type":"string","nullable":true}]},"bank_account_type":{"allOf":[{"$ref":"#/components/schemas/BankAccountTypes"},{"type":"string","nullable":true}]},"bank_routing_number":{"type":"string","description":"Bank routing number"},"bank_account_number":{"type":"string","description":"Bank account number (may be redacted unless show_sensitive_data=true)"},"bank_name":{"type":"string","nullable":true,"description":"Name of the bank"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the bank account was last updated"}}}}}}}}},"BusinessListOwnersRequest":{"type":"object","required":["business_id"],"properties":{"business_id":{"type":"string","format":"string","description":"ID of the business to list owners for"},"verbose":{"type":"boolean","description":"Whether to include related person details in the response"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"BusinessListOwnersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_owners":{"type":"array","items":{"type":"object","properties":{"business_owner_id":{"type":"string","format":"string","description":"ID of the business-owner relationship"},"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"ownership_type":{"allOf":[{"$ref":"#/components/schemas/BeneficialOwnershipType"},{"type":"string","nullable":true}]},"ownership_percentage":{"type":"number","nullable":true,"description":"Percentage of ownership (0-100)"},"ownership_year_month":{"type":"string","nullable":true,"description":"Year and month when ownership began (YYYY-MM format)"},"business_person_position":{"allOf":[{"$ref":"#/components/schemas/BusinessPersonPositions"},{"type":"string","nullable":true}]},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"},"person":{"type":"object","description":"Person details (included when verbose=true)","properties":{"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number (redacted unless show_sensitive_data=true)"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]},"description":"Addresses of the person"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the person was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the person was last updated"}}}}}}}}}},"BusinessRemoveBankAccountRequest":{"type":"object","required":["business_bank_account_id"],"properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship to remove"}}},"BusinessRemoveBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful removal","additionalProperties":false}}},"BusinessUpdateBankAccountRequest":{"type":"object","required":["business_bank_account_id"],"properties":{"business_bank_account_id":{"type":"string","format":"string","description":"ID of the business-bank account relationship to update"},"business_bank_account":{"type":"object","properties":{"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountPurposes"},"description":"New array of purposes for the bank account. Set to null to clear all purposes."}}}}},"BusinessUpdateBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"BusinessRemoveOwnerRequest":{"type":"object","required":["business_owner_id"],"properties":{"business_owner_id":{"type":"string","format":"string","description":"ID of the business-owner relationship to remove"}}},"BusinessRemoveOwnerResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful removal","additionalProperties":false}}},"BusinessAddLocationRequest":{"type":"object","required":["business_id","business_location"],"properties":{"business_id":{"type":"string","description":"The ID of the business entity"},"business_location":{"type":"object","required":["location_id"],"properties":{"location_id":{"type":"string","description":"The ID of the location to add as a Business Location"}}}}},"BusinessAddLocationResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_location":{"type":"object","properties":{"business_location_id":{"type":"string","description":"ID of the newly created business-location relationship"}}}}}}},"BusinessGetLocationRequest":{"type":"object","required":["business_location_id"],"properties":{"business_location_id":{"type":"string","description":"ID of the business location to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response (defaults to false if not provided)"},"verbose":{"type":"boolean","description":"Whether to include the associated location entity in the response"}}},"BusinessGetLocationResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_location":{"type":"object","properties":{"business_location_id":{"type":"string","description":"The ID of the Business Location"},"location_id":{"type":"string","description":"The Location that is associated with the business"},"location":{"description":"Location details (included when verbose=true)","allOf":[{"$ref":"#/components/schemas/Location"}]},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the business location relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the business location relationship was last updated"}}}}}}},"BusinessListLocationsRequest":{"type":"object","required":["business_id"],"properties":{"business_id":{"type":"string","description":"ID of the business to list locations for"},"verbose":{"type":"boolean","description":"Whether to include related location details in the response"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"BusinessListLocationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"business_locations":{"type":"array","items":{"type":"object","properties":{"business_location_id":{"type":"string","description":"ID of the business-location relationship"},"location_id":{"type":"string","description":"ID of the location entity"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the relationship was last updated"},"location":{"description":"Location details (included when verbose=true)","allOf":[{"$ref":"#/components/schemas/Location"}]}}}}}}}},"BusinessRemoveLocationRequest":{"type":"object","required":["business_location_id"],"properties":{"business_location_id":{"type":"string","description":"ID of the business-location relationship to remove"}}},"BusinessRemoveLocationResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful removal","additionalProperties":false}}},"BusinessSalesInfoCreateRequest":{"type":"object","required":["business_id"],"description":"Request to create sales information for a business","properties":{"business_id":{"type":"string","format":"string","description":"ID of the business to create sales information for"},"sales_info":{"type":"object","description":"Sales information details","properties":{"card_brands":{"type":"array","description":"Accepted card brands","items":{"$ref":"#/components/schemas/CardBrands"}},"sales_method":{"type":"object","description":"Sales method distribution percentages (must sum to 100).\nNote: The sum-to-100 constraint is a business rule and will be validated server-side; the schema does not enforce this constraint.\n","x-validation-note":"The sum of retail, telephone, online, and keyed must equal 100. This is enforced server-side.","required":["retail","telephone","online","keyed"],"properties":{"retail":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of retail sales"},"telephone":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of telephone sales"},"online":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of online sales"},"keyed":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of keyed sales"}}},"sales_amount":{"type":"array","description":"Sales amount information","items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"$ref":"#/components/schemas/SalesAmountTypes"},"value":{"type":"number","minimum":0,"description":"Sales amount value"},"currency":{"allOf":[{"$ref":"#/components/schemas/Currencies"},{"type":"string","description":"Currency code"}]}}}}}}}},"BusinessSalesInfoCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"sales_info":{"type":"object","properties":{"sales_info_id":{"type":"string","format":"string","description":"Unique identifier for the created sales information"}}}}}}},"BusinessSalesInfoDeleteRequest":{"type":"object","required":["sales_info_id"],"description":"Request to delete sales information","properties":{"sales_info_id":{"type":"string","format":"string","description":"ID of the sales information to delete"}}},"BusinessSalesInfoDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"BusinessSalesInfoGetRequest":{"type":"object","required":["sales_info_id"],"description":"Request to get sales information details","properties":{"sales_info_id":{"type":"string","format":"string","description":"ID of the sales information to retrieve"}}},"BusinessSalesInfoGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"sales_info":{"type":"object","properties":{"sales_info_id":{"type":"string","format":"string","description":"Unique identifier for the sales information"},"card_brands":{"type":"array","description":"Accepted card brands","items":{"$ref":"#/components/schemas/CardBrands"}},"sales_method":{"type":"object","description":"Sales method distribution percentages","properties":{"retail":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of retail sales"},"telephone":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of telephone sales"},"online":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of online sales"},"keyed":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of keyed sales"}}},"sales_amount":{"type":"array","description":"Sales amount information","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SalesAmountTypes"},"value":{"type":"number","minimum":0,"description":"Sales amount value"},"currency":{"allOf":[{"$ref":"#/components/schemas/Currencies"},{"type":"string","description":"Currency code"}]}}}}}}}}}},"BusinessSalesInfoUpdateRequest":{"type":"object","required":["sales_info_id"],"description":"Request to update sales information for a business","properties":{"sales_info_id":{"type":"string","format":"string","description":"ID of the sales info to make update for"},"sales_info":{"type":"object","description":"Sales information details","properties":{"card_brands":{"type":"array","nullable":true,"description":"Accepted card brands","items":{"$ref":"#/components/schemas/CardBrands"}},"sales_method":{"type":"object","nullable":true,"description":"Sales method distribution percentages (must sum to 100).\nNote: The sum-to-100 constraint is a business rule and will be validated server-side; the schema does not enforce this constraint.\n","x-validation-note":"The sum of retail, telephone, online, and keyed must equal 100. This is enforced server-side.","required":["retail","telephone","online","keyed"],"properties":{"retail":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of retail sales"},"telephone":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of telephone sales"},"online":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of online sales"},"keyed":{"type":"integer","minimum":0,"maximum":100,"description":"Percentage of keyed sales"}}},"sales_amount":{"type":"array","description":"Sales amount information","nullable":true,"items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"$ref":"#/components/schemas/SalesAmountTypes"},"value":{"type":"number","minimum":0,"description":"Sales amount value"},"currency":{"allOf":[{"$ref":"#/components/schemas/Currencies"},{"type":"string","description":"Currency code"}]}}}}}}}},"BusinessSalesInfoUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"LocationCreateRequest":{"type":"object","required":["subject_record_id","location"],"description":"Request to create a new location entity","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the subject record"},"location":{"type":"object","description":"Location entity details","properties":{"location_type":{"$ref":"#/components/schemas/LocationTypes","nullable":true,"description":"Type of the location (uses LocationTypes enum)"},"location_name":{"type":"string","nullable":true,"description":"Name of the location"},"owner_type":{"$ref":"#/components/schemas/LocationOwnerTypes","nullable":true,"description":"Owner type of the location (uses LocationOwnerTypes enum)"},"owner_name":{"type":"string","nullable":true,"description":"Name of the location owner"},"address":{"type":"object","nullable":true,"description":"Address details of the location","$ref":"#/components/schemas/BaseAddress"}}}}},"LocationCreateResponse":{"type":"object","properties":{"location_id":{"type":"string","format":"string","description":"ID of the newly created location"}}},"LocationGetRequest":{"type":"object","required":["location_id"],"properties":{"location_id":{"type":"string","format":"string","description":"ID of the location to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include related entities (location_bank_accounts) and their details in the response"}}},"LocationGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/Location"}}}}},"LocationListRequest":{"type":"object","required":["subject_record_id"],"properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record to list locations for"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include related entities (location_bank_accounts) and their details in the response"}}},"LocationListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"locations":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Location"}]}}}}}},"LocationUpdateRequest":{"type":"object","required":["location_id"],"description":"Request to update an existing location entity","properties":{"location_id":{"type":"string","format":"string","description":"The ID of the location to update"},"location":{"type":"object","description":"Location entity details to update","properties":{"location_type":{"$ref":"#/components/schemas/LocationTypes","nullable":true,"description":"Type of the location (uses LocationTypes enum)"},"location_name":{"type":"string","nullable":true,"description":"Name of the location"},"owner_type":{"$ref":"#/components/schemas/LocationOwnerTypes","nullable":true,"description":"Owner type of the location (uses LocationOwnerTypes enum)"},"owner_name":{"type":"string","nullable":true,"description":"Name of the location owner"},"address":{"type":"object","nullable":true,"description":"Address details of the location","$ref":"#/components/schemas/BaseAddress"}}}}},"LocationUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"LocationDeleteRequest":{"type":"object","required":["location_id"],"properties":{"location_id":{"type":"string","format":"string","description":"ID of the location to delete"}}},"LocationDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"LocationAddBankAccountRequest":{"type":"object","required":["location_id","location_bank_account"],"properties":{"location_id":{"type":"string","description":"ID of the location entity"},"location_bank_account":{"type":"object","required":["bank_account_id","bank_account_purposes"],"properties":{"bank_account_id":{"type":"string","description":"ID of the bank account to associate to location"},"bank_account_purposes":{"type":"array","items":{"$ref":"#/components/schemas/LocationBankAccountPurposes"}}}}}},"LocationAddBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"location_bank_account":{"type":"object","properties":{"location_bank_account_id":{"type":"string","description":"ID of the newly created location bank account relationship"}}}}}}},"LocationGetBankAccountRequest":{"type":"object","required":["location_bank_account_id"],"properties":{"location_bank_account_id":{"type":"string","format":"string","description":"ID of the location bank account to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include related entities (bank_account) and their details in the response"}}},"LocationGetBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/LocationBankAccount"}}}}},"LocationListBankAccountsRequest":{"type":"object","required":["location_id"],"properties":{"location_id":{"type":"string","format":"string","description":"ID of the location to list bank accounts for"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"},"verbose":{"type":"boolean","description":"Whether to include related entities (bank_accounts) and their details in the response"}}},"LocationListBankAccountsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"locations":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationBankAccount"}]}}}}}},"LocationRemoveBankAccountRequest":{"type":"object","required":["location_bank_account_id"],"properties":{"location_bank_account_id":{"type":"string","description":"ID of the location-bank account relationship to remove"}}},"LocationRemoveBankAccountResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful removal","additionalProperties":false}}},"MetadataTypeDefineRequest":{"type":"object","required":["account_id","metadata_type","fields","max_count"],"description":"Request to define a new metadata type and its fields definition","properties":{"account_id":{"type":"string","description":"The account ID under which the subject record is created","example":"acc_123456789012"},"metadata_type":{"type":"string","description":"Name of the metadata type to define","example":"IP_ADDRESS"},"fields":{"type":"object","description":"Dynamic object defining the schema of metadata details for this metadata type. Each key is a field name, and the value is an object defining the field properties.","additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Data type of the field (Allowed values are \"string\", \"integer\", \"boolean\")"},"description":{"type":"string","description":"Description of the field"},"required":{"type":"boolean","description":"Whether the field is required"},"format":{"type":"string","description":"Additional formatting constraints for the field (Allowed values are \"ipv4\", \"ipv6\")"}}},"example":{"ip_address":{"type":"string","description":"The IP address value","required":true,"format":"ipv4"},"allocation_method":{"type":"string","description":"Method of IP allocation"}}},"max_count":{"type":"integer","description":"Maximum number of metadata details entries of this type allowed per subject record (Allowed values are -1, or any positive integer, where -1 indicates no limit)","example":-1}}},"MetadataTypeDefineResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful request","additionalProperties":false}}},"MetadataCreateRequest":{"type":"object","required":["subject_record_id","metadata"],"description":"Request to create new metadata","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the subject record"},"metadata":{"type":"object","description":"Metadata details","properties":{"metadata_type":{"type":"string","description":"Type of the metadata"},"details":{"type":"object","description":"Key-value pairs for metadata","additionalProperties":true,"example":{"ip_address":"192.168.1.1","allocation_method":"dynamic"}}}}}},"MetadataUpdateRequest":{"type":"object","required":["metadata_id","metadata"],"description":"Request to update metadata details","properties":{"metadata_id":{"type":"string","format":"string","description":"The ID of the metadata detail record"},"metadata":{"type":"object","description":"Metadata details","properties":{"details":{"type":"object","description":"Key-value pairs for metadata","additionalProperties":true,"example":{"ip_address":"192.168.1.1","allocation_method":"dynamic"}}}}}},"MetadataCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"metadata":{"type":"object","properties":{"metadata_id":{"type":"string","format":"string","description":"ID of the newly created metadata entry"}}}}}}},"MetadataUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"MetadataGetRequest":{"type":"object","required":["metadata_id"],"description":"Request to retrieve details of existing MetadataDetail entity","properties":{"metadata_id":{"type":"string","format":"string","description":"The ID of the MetadataDetail entity to retrieve","example":"md_17USYmUTu2cCOVi7HG4hoE"}}},"MetadataGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetadataDetails"}}}}},"MetadataListRequest":{"type":"object","required":["subject_record_id"],"description":"Request to retrieve details of existing MetadataDetail entity","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the SubjectRecord whose metadata is to be listed","example":"sr_4zamstFMH83R40CQpjaoG9"},"filters":{"type":"object","description":"Optional filters to apply when listing metadata entries.","properties":{"metadata_type":{"type":"array","description":"Filter metadata entries by their metadata type(s)","items":{"type":"string"},"example":["IP_ADDRESS","DEVICE_ID"]},"linked_entity_id":{"type":"array","description":"Filter metadata entries that are linked to specific entity ID(s) (e.g., person_id, business_id)","items":{"type":"string"},"example":["p_1A2b3C4d5E6f7G8h9I0jKL","b_1Z2y3X4w5V6u7T8s9R0qMN"]}}}}},"MetadataListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"array","description":"Array of metadata entries associated with the subject record grouped by metadata type","items":{"type":"object","properties":{"metadata_type":{"type":"string","description":"Type of the metadata","example":"IP_ADDRESS"},"entries":{"type":"array","description":"Array of metadata entries for the specified metadata type","items":{"$ref":"#/components/schemas/MetadataDetails"}}}}}}},"PersonCreateRequest":{"type":"object","required":["subject_record_id","person"],"description":"Request to create a new person entity","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the subject record"},"person":{"type":"object","description":"Person entity details","properties":{"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship (uses COUNTRIES enum)"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]}}}}}},"PersonCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"person":{"type":"object","properties":{"person_id":{"type":"string","format":"string","description":"ID of the newly created person entity"}}}}}}},"PersonUpdateRequest":{"type":"object","required":["person_id"],"description":"Request to update an existing person entity","properties":{"person_id":{"type":"string","format":"string","description":"The ID of the person to update"},"person":{"type":"object","description":"Person entity details to update","properties":{"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship (uses COUNTRIES enum)"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","nullable":true,"items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]}}}}}},"PersonUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"PersonDeleteRequest":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","format":"string","description":"ID of the person to delete"}}},"PersonDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"PersonGetRequest":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","format":"string","description":"ID of the person to retrieve"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"PersonGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"person":{"type":"object","properties":{"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]},"description":"Addresses of the person"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the person was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the person was last updated"}}}}}}},"PersonListRequest":{"type":"object","required":["subject_record_id"],"properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record to list persons for"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"PersonListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"persons":{"type":"array","items":{"type":"object","properties":{"person_id":{"type":"string","format":"string","description":"ID of the person entity"},"email":{"type":"string","nullable":true,"description":"Email address of the person"},"first_name":{"type":"string","nullable":true,"description":"First name of the person"},"middle_name":{"type":"string","nullable":true,"description":"Middle name of the person"},"last_name":{"type":"string","nullable":true,"description":"Last name of the person"},"date_of_birth":{"type":"string","format":"date","nullable":true,"description":"Date of birth in ISO 8601 format"},"tax_id":{"type":"string","nullable":true,"description":"Tax identification number"},"citizenship":{"type":"string","nullable":true,"description":"Country of citizenship"},"phone_number":{"type":"string","nullable":true,"description":"Phone number of the person"},"addresses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PersonAddressTypes"}}}]},"description":"Addresses of the person"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the person was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the person was last updated"}}}}}}}},"PersonIssuedIdentifierCreateRequest":{"type":"object","required":["person_id","issued_identifiers"],"description":"Request to create a new person issued identifier","properties":{"person_id":{"type":"string","description":"The ID of the person entity to create issued identifier for"},"issued_identifiers":{"type":"object","required":["type","issued_number"],"description":"Person issued identifier details","properties":{"type":{"$ref":"#/components/schemas/PersonIssuedIdentifierTypes"},"issued_number":{"type":"string","description":"The issued identifier number"}}}}},"PersonIssuedIdentifierCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"person":{"type":"object","properties":{"issued_identifier_id":{"type":"string","description":"ID of the newly created person issued identifier"}}}}}}},"PersonIssuedIdentifierGetRequest":{"type":"object","required":["issued_identifier_id"],"properties":{"issued_identifier_id":{"type":"string","description":"ID of the person issued identifier to retrieve"}}},"PersonIssuedIdentifierGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"issued_identifier":{"$ref":"#/components/schemas/PersonIssuedIdentifier"}}}}},"PersonIssuedIdentifierListRequest":{"type":"object","required":["person_id"],"properties":{"person_id":{"type":"string","description":"ID of the person to list issued identifiers for"},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response"}}},"PersonIssuedIdentifierListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"issued_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/PersonIssuedIdentifier"}}}}}},"PersonIssuedIdentifierUpdateRequest":{"type":"object","required":["issued_identifier"],"description":"Request to update an existing person issued identifier","properties":{"issued_identifier_id":{"type":"string","description":"The ID of the person issued identifier to update"},"issued_identifier":{"type":"object","description":"Person issued identifier details to update","properties":{"type":{"$ref":"#/components/schemas/PersonIssuedIdentifierTypes"},"issued_number":{"type":"string","description":"The issued identifier number"}}}}},"PersonIssuedIdentifierUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful update","additionalProperties":false}}},"PersonIssuedIdentifierDeleteRequest":{"type":"object","required":["issued_identifier_id"],"properties":{"issued_identifier_id":{"type":"string","format":"string","description":"ID of the person issued identifier to delete"}}},"PersonIssuedIdentifierDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"SubjectRecordCreateRequest":{"type":"object","required":["account_id","subject_record"],"description":"Request to create a new subject record","properties":{"account_id":{"type":"string","description":"The account ID under which the subject record is created"},"subject_record":{"type":"object","required":["type"],"description":"Subject record details","properties":{"type":{"$ref":"#/components/schemas/SubjectRecordTypes"}}}}},"SubjectRecordCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"subject_record":{"type":"object","properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the newly created subject record"}}}}}}},"SubjectRecordGetRequest":{"type":"object","required":["subject_record_id"],"properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record to retrieve"},"verbose":{"type":"boolean","description":"Whether to include related entities (bank accounts, business, persons, workflows) in the response","default":false},"show_sensitive_data":{"type":"boolean","description":"Whether to include sensitive data in the response (requires verbose to be true)","default":false}}},"SubjectRecordGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"subject_record":{"type":"object","properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record"},"subject_record_type":{"type":"string","format":"string","description":"Type of the subject record"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the subject record was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the subject record was last updated"},"bank_accounts":{"type":"array","description":"Bank accounts associated with the subject record (only included when verbose=true)","items":{"type":"object","description":"Bank account details"}},"business":{"type":"object","description":"Business information associated with the subject record (only included when verbose=true)"},"persons":{"type":"array","description":"Persons associated with the subject record (only included when verbose=true)","items":{"type":"object","description":"Person details"}},"workflows":{"type":"array","description":"Workflows associated with the subject record (only included when verbose=true)","items":{"type":"object","description":"Workflow details"}}}}}}}},"SubjectRecordDeleteRequest":{"type":"object","required":["subject_record_id"],"description":"Request to delete a subject record","properties":{"subject_record_id":{"type":"string","format":"string","description":"The ID of the Subject Record to delete"}}},"SubjectRecordDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"SubjectRecordListRequest":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string","description":"The identifier for the Subject Record from which to list all the Subject Record objects."}}},"SubjectRecordListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"subject_records":{"type":"array","description":"An array of Subject Record objects under an account. If an account has no Subject Record objects, the array will be empty.","items":{"type":"object","properties":{"subject_record_id":{"type":"string","description":"The subject record Id"},"subject_record_type":{"type":"string","format":"string","description":"Type of the subject record"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Subject Record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Subject Record was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."}}}}}}}},"WebhookKeyCreateRequest":{"type":"object","required":["account_id"],"description":"Request to create a new webhook encryption key","properties":{"account_id":{"type":"string","description":"The account identifier to create the webhook key for"}}},"WebhookKeyCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"webhook_key":{"type":"object","properties":{"key_id":{"type":"string","description":"The identifier for the webhook key (format whk_YYYYMMDD_NN)"},"shared_secret":{"type":"string","description":"The Base64-encoded encryption key. Store this securely - it is only returned once."},"status":{"$ref":"#/components/schemas/WebhookKeyStatuses","description":"The current status of the key. Will be INACTIVE for newly created keys."},"created_at":{"type":"string","format":"date-time","description":"The date-time when the key was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"}}}}}}},"WebhookKeyGetRequest":{"type":"object","required":["key_id"],"description":"Request to retrieve details about a specific webhook encryption key","properties":{"key_id":{"type":"string","description":"The identifier for the webhook key (format whk_YYYYMMDD_NN)"}}},"WebhookKeyGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"webhook_key":{"type":"object","properties":{"key_id":{"type":"string","description":"The identifier for the webhook key"},"status":{"$ref":"#/components/schemas/WebhookKeyStatuses","description":"The current status of the key"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the key was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"},"activated_at":{"type":"string","format":"date-time","nullable":true,"description":"The date-time when the key was activated in ISO 8601 format. Only present if the key has been activated."},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"The date-time when the key was deleted in ISO 8601 format. Only present if the key has been deleted."}}}}}}},"WebhookKeyActivateRequest":{"type":"object","required":["key_id"],"description":"Request to activate a webhook encryption key","properties":{"key_id":{"type":"string","description":"The identifier for the webhook key to activate (format whk_YYYYMMDD_NN)"}}},"WebhookKeyActivateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"webhook_key":{"type":"object","properties":{"key_id":{"type":"string","description":"The identifier for the webhook key that was activated"},"status":{"$ref":"#/components/schemas/WebhookKeyStatuses","description":"The current status of the key. Will be ACTIVE after successful activation."},"activated_at":{"type":"string","format":"date-time","description":"The date-time when the key was activated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"}}}}}}},"WebhookConfigCreateRequest":{"type":"object","required":["account_id","config"],"description":"Request to create a new webhook configuration","properties":{"account_id":{"type":"string","description":"The account identifier to create the webhook configuration for"},"config":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The HTTPS URL endpoint where webhooks will be sent. Must use HTTPS protocol.","example":"https://example.com/webhooks"}}}}},"WebhookConfigCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"config_id":{"type":"string","description":"The unique identifier for the webhook configuration (format whc_XXXXXXXX)","example":"whc_abc12345"}}}}},"WebhookConfigGetRequest":{"type":"object","required":["account_id","config_id"],"description":"Request to retrieve details about a specific webhook configuration","properties":{"account_id":{"type":"string","description":"The account identifier"},"config_id":{"type":"string","description":"The identifier for the webhook configuration (format whc_XXXXXXXX)","example":"whc_abc12345"}}},"WebhookConfigGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"config_id":{"type":"string","description":"The unique identifier for the webhook configuration","example":"whc_abc12345"},"url":{"type":"string","format":"uri","description":"The webhook endpoint URL","example":"https://example.com/webhooks"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the configuration was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"},"updated_at":{"type":"string","format":"date-time","nullable":true,"description":"The date-time when the configuration was last updated in ISO 8601 format. Only present if the configuration has been updated."}}}}},"WebhookConfigUpdateRequest":{"type":"object","required":["account_id","config_id","config"],"description":"Request to update an existing webhook configuration","properties":{"account_id":{"type":"string","description":"The account identifier"},"config_id":{"type":"string","description":"The identifier for the webhook configuration to update (format whc_XXXXXXXX)","example":"whc_abc12345"},"config":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The new HTTPS URL endpoint where webhooks will be sent. Must use HTTPS protocol.","example":"https://example.com/webhooks/new"}}}}},"WebhookConfigUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object on successful update"}}},"WebhookConfigListRequest":{"type":"object","required":["account_id"],"description":"Request to list all active webhook configurations for an account","properties":{"account_id":{"type":"string","description":"The account identifier to list configurations for"}}},"WebhookConfigListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"configs":{"type":"array","description":"List of active webhook configurations","items":{"type":"object","properties":{"config_id":{"type":"string","description":"The unique identifier for the webhook configuration","example":"whc_abc12345"},"url":{"type":"string","format":"uri","description":"The webhook endpoint URL","example":"https://example.com/webhooks"},"created_at":{"type":"string","format":"date-time","description":"The date-time when the configuration was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the configuration was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)"}}}}}}}},"WebhookConfigDeleteRequest":{"type":"object","required":["account_id","config_id"],"description":"Request to delete a webhook configuration","properties":{"account_id":{"type":"string","description":"The account identifier"},"config_id":{"type":"string","description":"The identifier for the webhook configuration to delete (format whc_XXXXXXXX)","example":"whc_abc12345"}}},"WebhookConfigDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object on successful deletion"}}},"WorkflowCanCompleteRequest":{"type":"object","required":["workflow_id"],"description":"Request to check if a workflow can be completed","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow to check"}}},"WorkflowCanCompleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","required":["can_complete"],"properties":{"can_complete":{"type":"boolean","description":"Whether the workflow can be completed"},"missing_requirements":{"type":"array","description":"List of missing requirements if workflow cannot be completed","items":{"type":"object","required":["code","entity_type","message"],"properties":{"code":{"$ref":"#/components/schemas/MissingRequirements"},"entity_type":{"$ref":"#/components/schemas/EntityTypes"},"entity_id":{"type":"string","nullable":true,"description":"ID of the specific entity that has missing requirements"},"message":{"type":"string","description":"Human-readable description of the missing requirement"},"related_methods":{"type":"array","nullable":true,"description":"API methods that may be relevant to resolve the requirement","items":{"type":"string"}},"related_endpoints":{"type":"array","nullable":true,"description":"API endpoints that may be relevant to resolve the requirement","items":{"type":"string"}},"fields":{"type":"array","nullable":true,"description":"Specific fields that are missing or required","items":{"type":"string"}}}}}}}}},"WorkflowCompleteRequest":{"type":"object","required":["workflow_id"],"description":"Request to complete a workflow","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow to complete"}}},"WorkflowCompleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful workflow completion","additionalProperties":false}}},"WorkflowCreateRequest":{"type":"object","required":["account_id","workflow"],"description":"Request to create a new workflow","properties":{"account_id":{"type":"string","description":"The partner account ID"},"workflow":{"type":"object","required":["type"],"description":"Workflow details","properties":{"type":{"$ref":"#/components/schemas/WorkflowTypes"},"state":{"$ref":"#/components/schemas/WorkflowStates"},"subject_record_id":{"type":"string","format":"string","nullable":true,"description":"Optional ID of an existing subject record to associate with this workflow"},"details":{"type":"object","properties":{"business_application_details":{"type":"object","required":["applying_user"],"properties":{"pricing_model_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the pricing model to apply"},"equipment_collection_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the equipment catalog"},"referrer_value":{"type":"string","nullable":true,"description":"The customer provided value to identify how application was referred, such as a marketplace, website, or sales person. This field is limited to 100 characters."},"applying_user":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the applying user"},"first_name":{"type":"string","nullable":true,"description":"First name of the applying user"},"last_name":{"type":"string","nullable":true,"description":"Last name of the applying user"}}}}}}}}}}},"WorkflowCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"workflow":{"type":"object","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the newly created workflow"},"subject_record_id":{"type":"string","format":"string","description":"ID of the associated subject record"}}}}}}},"WorkflowUpdateRequest":{"type":"object","required":["workflow_id","workflow"],"description":"Request to update an existing workflow","properties":{"workflow_id":{"type":"string","description":"The ID of the workflow to update"},"workflow":{"type":"object","description":"Workflow details to update","properties":{"details":{"type":"object","properties":{"business_application_details":{"type":"object","properties":{"pricing_model_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the pricing model to apply"},"equipment_collection_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the equipment catalog"},"referrer_value":{"type":"string","nullable":true,"description":"The customer provided value to identify how application was referred, such as a marketplace, website, or sales person. This field is limited to 100 characters."},"applying_user":{"type":"object","properties":{"email":{"type":"string","nullable":true,"description":"Email address of the applying user"},"first_name":{"type":"string","nullable":true,"description":"First name of the applying user"},"last_name":{"type":"string","nullable":true,"description":"Last name of the applying user"}}}}}}}}}}},"WorkflowUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful workflow update","additionalProperties":false}}},"WorkflowPricingCalculateRequest":{"type":"object","required":["workflow_id"],"description":"Request to calculate pricing for a workflow","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow for which to calculate pricing"}}},"WorkflowPricingCalculateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful pricing calculation","additionalProperties":false}}},"WorkflowPricingGetRequest":{"type":"object","required":["workflow_id"],"description":"Request to get pricing details for a workflow","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow to get pricing for"}}},"WorkflowPricingGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"pricing":{"type":"object","required":["items"],"properties":{"type":{"$ref":"#/components/schemas/PricingTypes","description":"Type of the pricing. One of PRICING_TYPES."},"items":{"type":"array","description":"Array of individual pricing components and rates.\n","items":{"type":"object","required":["item_code","value_type","details"],"properties":{"item_code":{"$ref":"#/components/schemas/PricingItemCodes","description":"Name of the pricing component. One of PRICING_ITEM_CODES."},"value_type":{"$ref":"#/components/schemas/PricingItemTypes","description":"Pricing item type. One of PRICING_ITEM_TYPES."},"details":{"type":"object","description":"Details of the related item_code","properties":{"value":{"type":"number","description":"The pricing value or configuration value.\nFor percentage types, this represents the actual percentage (e.g., 2.9 = 2.9%).\nFor flat fee types, this represents the monetary amount (e.g., 0.3 = $0.30).\n"},"currency":{"$ref":"#/components/schemas/Currencies","description":"Currency code for flat fee pricing items. Currently only USD is supported."},"unit":{"type":"string","description":"Unit for PER_UNIT pricing items (e.g., BPS)"},"locales":{"type":"array","description":"Contains the custom text locales when available","items":{"type":"object","properties":{"locale":{"type":"string","description":"The language of the text locale"},"value":{"type":"string","description":"The value of the text locale"}}}}}}}}}}}}}},"example":{"meta":{"status":"SUCCESS","trace_id":"trc_6zNzQZHSf26V83BO3uW6dS","version":"2025-03-24"},"data":{"pricing":{"items":[{"item_code":"per_transaction_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"blended_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"amex_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"international_surcharge_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"credit_card_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"debit_card_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"international_rate","value_type":"PERCENTAGE","details":{"value":9.9}},{"item_code":"ach_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"ach_return_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"chargeback_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"maintenance_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"no_payment_maintenance_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"application_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"monthly_subscription_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"annual_subscription_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"internal_cost_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"credit_card_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"debit_card_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"amex_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"international_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"payouts_per_transaction_fee","value_type":"FIXED_AMOUNT","details":{"value":49.99,"currency":"USD"}},{"item_code":"rate_cost","value_type":"PER_UNIT","details":{"value":49.99,"currency":"USD","unit":"BPS"}},{"item_code":"custom_pricing","value_type":"CUSTOM_TEXT","details":{"locales":[{"locale":"en_US","value":"Your application qualifies for custom pricing. Our sales team will reach you shortly."}]}}]}}}},"WorkflowStartRequest":{"type":"object","required":["workflow_id"],"description":"Request to start a workflow","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow to start"}}},"WorkflowStartResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful workflow start","additionalProperties":false}}},"WorkflowListRequest":{"type":"object","required":["subject_record_id"],"description":"Request to list all workflows within a subject record","properties":{"subject_record_id":{"type":"string","format":"string","description":"ID of the subject record to list workflows for"}}},"WorkflowListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"workflows":{"type":"array","description":"List of workflows associated with the subject record","items":{"$ref":"#/components/schemas/Workflow"}}}}}},"WorkflowGetRequest":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow to retrieve"}}},"WorkflowGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"workflow":{"type":"object","properties":{"workflow_id":{"type":"string","format":"string","description":"ID of the workflow"},"type":{"$ref":"#/components/schemas/WorkflowTypes"},"subject_record_id":{"type":"string","format":"string","description":"ID of the associated subject record"},"state":{"$ref":"#/components/schemas/WorkflowStates"},"details":{"type":"object","properties":{"business_application_details":{"type":"object","properties":{"pricing_model_id":{"type":"string","format":"uuid","description":"ID of the pricing model"},"equipment_collection_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the equipment catalog"},"referrer_value":{"type":"string","nullable":true,"description":"The customer provided value to identify how application was referred, such as a marketplace, website, or sales person. This field is limited to 100 characters."},"applying_user":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the applying user"},"first_name":{"type":"string","nullable":true,"description":"First name of the applying user"},"last_name":{"type":"string","nullable":true,"description":"Last name of the applying user"}}}}}}},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the workflow was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the workflow was last updated"},"started_at":{"type":"string","format":"date-time","description":"Timestamp when the workflow was started"},"ended_at":{"type":"string","format":"date-time","description":"Timestamp when the workflow was ended"}}}}}}},"WorkflowDeleteRequest":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"ID of the workflow to delete"}}},"WorkflowDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion","additionalProperties":false}}},"WorkflowRequiredDocumentListRequest":{"type":"object","required":["workflow_id"],"description":"Request to list required documents for a workflow with optional filtering","properties":{"workflow_id":{"type":"string","description":"ID of the workflow to list required documents for"},"filters":{"type":"object","description":"Optional filters to apply to the required documents list","properties":{"required_document_status":{"$ref":"#/components/schemas/RequiredDocumentStatuses"}}}}},"WorkflowRequiredDocumentListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"required_documents":{"type":"array","description":"List of required documents for the workflow","items":{"type":"object","required":["required_document_id","document_type_code","name","category","requirement_text","required_document_status","created_at","updated_at"],"properties":{"required_document_id":{"type":"string","description":"Unique identifier for the required document"},"document_type_code":{"type":"string","description":"Code identifying the type of document required"},"name":{"type":"string","description":"Human-readable name of the required document"},"category":{"type":"string","description":"Category of the required document"},"requirement_text":{"type":"string","description":"Text description of the requirement"},"required_document_status":{"$ref":"#/components/schemas/RequiredDocumentStatuses"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the required document was created in ISO 8601 format"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the required document was last updated in ISO 8601 format"}}}}}}}},"WorkflowRequiredDocumentCalculateRequest":{"type":"object","required":["workflow_id"],"description":"Request to calculate and generate required documents for a workflow","properties":{"workflow_id":{"type":"string","description":"ID of the workflow for which to calculate required documents"}}},"WorkflowRequiredDocumentCalculateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Calculation completed - no additional data returned","additionalProperties":false}}},"WorkflowRequiredDocumentBatchAddRequest":{"type":"object","required":["workflow_id","required_documents"],"description":"Request to add multiple required documents to a workflow in batch","properties":{"workflow_id":{"type":"string","description":"ID of the workflow to add required documents to"},"notification_parameters":{"type":"object","description":"Optional notification settings for the batch operation","properties":{"notify":{"type":"boolean","description":"Whether to send notifications for this operation"},"message":{"type":"string","description":"Custom notification message"}}},"required_documents":{"type":"array","description":"Array of required documents to add","items":{"type":"object","required":["document_type_code","requirement_text"],"properties":{"document_type_code":{"type":"string","description":"Code identifying the type of document required.\n"},"requirement_text":{"type":"string","description":"Text description of the requirement for this document"}}}}}},"WorkflowRequiredDocumentBatchAddResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaBatchProcessedResponse"},"results":{"type":"array","description":"Individual results for each document in the batch request","items":{"type":"object","required":["status","request"],"properties":{"status":{"type":"string","enum":["SUCCESS","ERROR"],"description":"Status of this individual operation"},"request":{"type":"object","description":"Echo of the original request data for this item","properties":{"document_type_code":{"type":"string"},"requirement_text":{"type":"string"}}},"data":{"type":"object","description":"Response data for successful operations. Empty for successful operations."},"errors":{"type":"array","description":"Error details for failed operations","items":{"$ref":"#/components/schemas/ErrorItem"}}}}}}},"WorkflowRequiredDocumentBatchRequestDocumentRequest":{"type":"object","required":["workflow_id","required_documents"],"description":"Batch request to initiate file requests for multiple required documents","properties":{"workflow_id":{"type":"string","description":"ID of the workflow with w_ prefix"},"required_documents":{"type":"array","description":"Array of required document identifiers to request files for","items":{"type":"object","required":["required_document_id"],"properties":{"required_document_id":{"type":"string","description":"Required document identifier with rd_ prefix"},"comments":{"type":"string","description":"Optional comments for this document request"}}}}}},"WorkflowRequiredDocumentBatchRequestDocumentResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaBatchProcessedResponse"},"results":{"type":"array","description":"Individual results for each document request in the batch","items":{"type":"object","required":["status","request"],"properties":{"status":{"type":"string","enum":["SUCCESS","ERROR"],"description":"Status of this individual operation"},"request":{"type":"object","description":"Echo of the original request data for this item","properties":{"required_document_id":{"type":"string","description":"Required document identifier with rd_ prefix"},"comments":{"type":"string","description":"Optional comments for this document request"}}},"data":{"type":"object","description":"Response data for successful operations. Empty for successful operations.","properties":{"document_request_id":{"type":"string","description":"Unique identifier for the document request"}}},"errors":{"type":"array","description":"Error details for failed operations","items":{"$ref":"#/components/schemas/ErrorItem"}}}}}}},"WorkflowRequiredDocumentFulfillmentBatchAddRequest":{"type":"object","required":["workflow_id","fulfillments"],"description":"Request to add multiple fulfillments in batch","properties":{"workflow_id":{"type":"string","description":"ID of the workflow with w_ prefix"},"fulfillments":{"type":"array","description":"Array of fulfillments to add","items":{"type":"object","required":["document_id","required_document_id"],"properties":{"document_id":{"type":"string","description":"Document identifier with d_ prefix"},"required_document_id":{"type":"string","description":"Required document identifier with rd_ prefix"},"decision_status":{"$ref":"#/components/schemas/FulfillmentDecisionStatuses","description":"Decision status for the fulfillment"},"document_request_id":{"type":"string","description":"Optional document request identifier for this fulfillment"}}}}}},"WorkflowRequiredDocumentFulfillmentBatchAddResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaBatchProcessedResponse"},"results":{"type":"array","description":"Individual results for each fulfillment in the batch request","items":{"type":"object","required":["status","request"],"properties":{"status":{"type":"string","enum":["SUCCESS","ERROR"],"description":"Status of this individual operation"},"request":{"type":"object","description":"Echo of the original request data for this item","properties":{"document_id":{"type":"string","description":"Document identifier"},"required_document_id":{"type":"string","description":"Required document identifier"},"decision_status":{"type":"string","description":"Decision status for the fulfillment"},"document_request_id":{"type":"string","description":"Document request identifier for this fulfillment"}}},"data":{"type":"object","description":"Empty object for successful operations","additionalProperties":false},"errors":{"type":"array","description":"Error details for failed operations","items":{"$ref":"#/components/schemas/ErrorItem"}}}}}}},"WorkflowRequiredDocumentFulfillmentListRequest":{"type":"object","required":["required_document_id"],"description":"Request to list fulfillments for a required document","properties":{"required_document_id":{"type":"string","description":"Required document identifier with rd_ prefix"},"filters":{"type":"object","description":"Optional filters to apply to the fulfillments list","properties":{"decision_status":{"$ref":"#/components/schemas/FulfillmentDecisionStatuses","description":"Filter by decision status"},"document_upload_status":{"$ref":"#/components/schemas/DocumentUploadStatuses","description":"Filter by document upload status"}}},"verbose":{"type":"boolean","description":"Include detailed document information and deleted_at field in the response.\nWhen false or omitted, the 'document' field is excluded and 'deleted_at' is excluded when null.\n"}}},"WorkflowRequiredDocumentFulfillmentListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"fulfillments":{"type":"array","description":"Array of fulfillment objects","items":{"type":"object","properties":{"fulfillment_id":{"type":"string","description":"Unique identifier for the fulfillment"},"document_id":{"type":"string","description":"Document identifier"},"required_document_id":{"type":"string","description":"Required document identifier"},"document":{"type":"object","nullable":true,"description":"Detailed document information (included only when verbose=true).\nOmitted when verbose is false or not provided.\n","properties":{"document_id":{"type":"string","description":"Document identifier"},"file_name":{"type":"string","description":"Name of the uploaded file"},"file_size_in_bytes":{"type":"integer","description":"File size in bytes"},"uploaded_by":{"type":"string","description":"User who uploaded the document"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when document was deleted (ISO 8601 format)"}}},"decision_status":{"$ref":"#/components/schemas/FulfillmentDecisionStatuses","description":"Current decision status of the fulfillment"},"decisioned_by":{"type":"string","nullable":true,"description":"User who made the decision"},"decisioned_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when decision was made (ISO 8601 format)"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when fulfillment was deleted (ISO 8601 format).\nOmitted when verbose is false and value is null.\n"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when fulfillment was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when fulfillment was last updated (ISO 8601 format)"}}}}}}}},"WorkflowRequiredDocumentFulfillmentUpdateRequest":{"type":"object","required":["fulfillment_id","decision_status"],"description":"Request to update a fulfillment's decision status","properties":{"fulfillment_id":{"type":"string","description":"Fulfillment identifier with f_ prefix"},"decision_status":{"$ref":"#/components/schemas/FulfillmentDecisionStatuses","description":"New decision status for the fulfillment"}}},"WorkflowRequiredDocumentFulfillmentUpdateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object returned on successful update"}}},"WorkflowRequiredDocumentFulfillmentDeleteRequest":{"type":"object","required":["fulfillment_id"],"description":"Request to delete a fulfillment","properties":{"fulfillment_id":{"type":"string","description":"Fulfillment identifier with f_ prefix"}}},"WorkflowRequiredDocumentFulfillmentDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion"}}},"WorkflowRequiredDocumentFulfillmentAddCommentRequest":{"type":"object","required":["fulfillment_id","comment_text"],"description":"Request to add a comment to a fulfillment","properties":{"fulfillment_id":{"type":"string","description":"Fulfillment identifier with f_ prefix"},"comment_text":{"type":"string","description":"Comment text to add to the fulfillment"}}},"WorkflowRequiredDocumentFulfillmentAddCommentResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"comment_id":{"type":"string","description":"ID of the created comment"}}}}},"WorkflowRequiredDocumentEventsListRequest":{"type":"object","required":["workflow_id"],"description":"Request to list workflow required document events with optional filtering","properties":{"workflow_id":{"type":"string","description":"Workflow identifier with w_ prefix"},"filters":{"type":"object","description":"Optional filters to apply to the events list","properties":{"fulfillment_id":{"type":"string","description":"Filter events by fulfillment ID with f_ prefix"}}}}},"WorkflowRequiredDocumentEventsListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"events":{"type":"array","description":"Array of workflow events. Empty array if no events found.","items":{"type":"object","properties":{"event_id":{"type":"string","description":"Event identifier"},"workflow_id":{"type":"string","description":"Workflow identifier"},"subject_record_id":{"type":"string","description":"Subject record identifier"},"event_name":{"type":"string","description":"Name of the event"},"created_by":{"type":"object","description":"User who created the event","properties":{"user_id":{"type":"string","description":"User identifier"},"type":{"type":"string","description":"User type (e.g., USER, SYSTEM)"}}},"metadata":{"type":"array","description":"Event-specific metadata","items":{"type":"object"}},"event_timestamp":{"type":"string","format":"date-time","description":"Timestamp when the event occurred"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the event was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the event was last updated"}}}}}}}},"WorkflowAgreementListRequest":{"type":"object","required":["workflow_id"],"description":"Request to list signed agreements for a workflow","properties":{"workflow_id":{"type":"string","description":"ID of the workflow to list signed agreements for"}}},"WorkflowAgreementListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"agreements":{"type":"array","description":"List of signed agreements for the workflow","items":{"type":"object","properties":{"agreement_id":{"type":"string","description":"Unique identifier for the signed agreement"},"agreement_name":{"type":"string","description":"The name of the agreement"},"signed_email":{"type":"string","description":"Email of the signer accepting the agreement"},"signed_at":{"type":"string","format":"date-time","description":"Timestamp when the agreemnt was accepted by signer in ISO 8601 format"}}}}}}}},"WorkflowAgreementGetDownloadRequest":{"type":"object","required":["agreement_id"],"description":"Request to get download URL for a signed agreement","properties":{"agreement_id":{"type":"string","description":"ID of the agreement to get download URL for"}}},"WorkflowAgreementGetDownloadResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"agreement":{"type":"object","description":"Signed agreement with download URL","properties":{"download_url":{"type":"string","format":"uri","description":"Presigned URL to download the signed agreement PDF. This URL is temporary and will expire."}}}}}}},"WorkflowUnderwritingDecisionListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"List of underwriting decisions for the workflow","properties":{"workflow_id":{"type":"string","description":"Workflow identifier"},"subject_record_id":{"type":"string","description":"Subject record identifier"},"underwriting_decisions":{"type":"array","description":"Array of underwriting decision objects","items":{"type":"object","properties":{"underwriting_decision_id":{"type":"string","description":"Unique identifier for the underwriting decision"},"status":{"type":"string","enum":["APPROVED","PENDING_REVIEW","DECLINED","IN_REVIEW","PAUSED","WITHDRAWN"],"description":"Status of the underwriting decision"},"decisioned_by":{"type":"string","description":"Identifier of the entity that made the decision"},"decisioned_at":{"type":"string","format":"date-time","description":"Timestamp when the decision was made"}}}}}}}},"WorkflowUnderwritingDecisionGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Detail of the underwriting decision","properties":{"underwriting_decision_id":{"type":"string","description":"Unique identifier for the underwriting decision"},"workflow_id":{"type":"string","description":"Workflow identifier"},"subject_record_id":{"type":"string","description":"Subject record identifier"},"status":{"type":"string","enum":["APPROVED","PENDING_REVIEW","DECLINED","IN_REVIEW","PAUSED","WITHDRAWN"],"description":"Status of the underwriting decision"},"decisioned_by":{"type":"string","description":"Identifier of the entity that made the decision"},"decisioned_at":{"type":"string","format":"date-time","description":"Timestamp when the decision was made"},"verification_decisions":{"type":"array","description":"List of verification decision objects associated with this underwriting decision","items":{"type":"object","properties":{"verification_decision_id":{"type":"string","description":"Unique identifier for the verification decision"},"entity_type":{"type":"string","enum":["BUSINESS","BANK_ACCOUNT_AGGREGATE","PERSON_AGGREGATE"],"description":"Type of entity"},"entity_ids":{"type":"array","description":"List of entity identifiers. It can be individual, multiple or empty","items":{"type":"string"}},"verification_type":{"type":"string","enum":["ENTITY_VERIFICATION","SANCTIONS_SCREEN","RISK_FLAGS","RISK_INDICATORS","MATCH","BANK_ACCOUNT","SITE_ANALYSIS","FRAUD_ANALYSIS"],"description":"Type of verification"},"status":{"type":"string","enum":["PASS","FAIL","NEEDS_REVIEW","NO_DECISION"],"description":"Status of the verification decision"},"decisioned_at":{"type":"string","format":"date-time","description":"Timestamp when the decision was made"},"comment":{"type":"string","description":"Comment added to the verification decision"},"decisioned_by":{"type":"string","description":"Identifier of the entity that made the decision"}}}}}}}},"AccountDocumentTypeListRequest":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string","description":"Account identifier"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"Filter by status. Valid values are ACTIVE or INACTIVE"}}},"AccountDocumentTypeListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"document_types":{"type":"array","items":{"type":"object","properties":{"account_document_type_id":{"type":"string","description":"Unique identifier for the account document type"},"document_type_code":{"type":"string","description":"Document type code (e.g., PASSPORT, BANK_STATEMENTS)"},"document_name":{"type":"string","description":"Display name for the document type"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"Current status of the document type"},"requirements":{"type":"object","description":"Default requirement for this document type","properties":{"default_requirement":{"type":"object","properties":{"requirement_text":{"type":"string","description":"Default requirement text"}}}}},"alternate_requirements":{"type":"array","nullable":true,"description":"Alternative specific requirements for this document type","items":{"type":"object","properties":{"requirement_text":{"type":"string","description":"Alternative requirement text"}}}}}}}}}}},"DocumentCreateRequest":{"type":"object","required":["subject_record_id","file_name","file_size_in_bytes"],"description":"Request to create a new document and get presigned upload URL","properties":{"subject_record_id":{"type":"string","description":"The subject record identifier with sr_ prefix","example":"sr_1rQYvnUQdcatd4TcZQu0l8"},"file_name":{"type":"string","description":"Name of the file to upload","example":"passport.pdf"},"file_size_in_bytes":{"type":"integer","description":"Size of the file in bytes","example":1048576}}},"DocumentCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","required":["document"],"properties":{"document":{"type":"object","required":["document_id","upload_url","presign_values"],"properties":{"document_id":{"type":"string","description":"Unique identifier for the created document with d_ prefix","example":"d_1rQYvnUQdcatd4TcZQu0l8"},"upload_url":{"type":"string","description":"S3 presigned URL for uploading the document file","example":"https://s3.amazonaws.com/bucket-name"},"presign_values":{"type":"object","description":"Form fields required for POST upload to S3 presigned URL","required":["Content-Type","X-Amz-Algorithm","X-Amz-Credential","X-Amz-Date","X-Amz-Security-Token","X-Amz-Signature","key","policy","x-amz-meta-document-id"],"properties":{"Content-Type":{"type":"string","description":"MIME type of the file being uploaded","example":"application/pdf"},"X-Amz-Algorithm":{"type":"string","description":"AWS signature algorithm","example":"AWS4-HMAC-SHA256"},"X-Amz-Credential":{"type":"string","description":"AWS credentials for the presigned request","example":"ASIAQHNPJKZEMBYT3MT4/20250925/us-east-1/s3/aws4_request"},"X-Amz-Date":{"type":"string","description":"Timestamp for the presigned request","example":"20250925T190851Z"},"X-Amz-Security-Token":{"type":"string","description":"AWS security token for temporary credentials"},"X-Amz-Signature":{"type":"string","description":"Signature for the presigned request"},"key":{"type":"string","description":"S3 object key (path) for the uploaded file","example":"sr_1rQYvnUQdcatd4TcZQu0l8/d_1rQYvnUQdcatd4TcZQu0l8.pdf"},"policy":{"type":"string","description":"Base64-encoded policy document for the upload"},"x-amz-meta-document-id":{"type":"string","description":"Document ID metadata attached to the S3 object","example":"d_1rQYvnUQdcatd4TcZQu0l8"}}}}}}}}},"DocumentListRequest":{"type":"object","required":["subject_record_id"],"description":"Request to list all documents for a subject record","properties":{"subject_record_id":{"type":"string","description":"The subject record identifier with sr_ prefix"}}},"DocumentListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"documents":{"type":"array","description":"List of documents associated with the subject record. Returns empty array if no documents found.","items":{"type":"object","required":["document_id","subject_record_id","file_name","file_size","content_type","upload_status","created_at","updated_at"],"properties":{"document_id":{"type":"string","description":"Unique identifier for the document"},"subject_record_id":{"type":"string","description":"Subject record identifier"},"file_name":{"type":"string","description":"Name of the uploaded file"},"file_size":{"type":"integer","description":"File size in bytes"},"content_type":{"type":"string","description":"MIME type of the file"},"upload_status":{"type":"string","description":"Current upload status of the document"},"comment":{"type":"string","nullable":true,"description":"Optional comment associated with the document. Omitted when null."},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the document was deleted (ISO 8601 format). Omitted when null."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the document was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the document was last updated (ISO 8601 format)"}}}}}}}},"DocumentGetRequest":{"type":"object","required":["document_id"],"description":"Request to get details of a specific document","properties":{"document_id":{"type":"string","description":"The document identifier with d_ prefix"}}},"DocumentGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"document":{"type":"object","required":["document_id","subject_record_id","file_name","file_size","content_type","document_path","upload_status","hash","comment","uploaded_by","deleted_at","created_at","updated_at"],"description":"Complete document details","properties":{"document_id":{"type":"string","description":"Unique identifier for the document"},"subject_record_id":{"type":"string","description":"Subject record identifier"},"file_name":{"type":"string","description":"Name of the uploaded file"},"file_size":{"type":"integer","description":"File size in bytes"},"content_type":{"type":"string","description":"MIME type of the file"},"document_path":{"type":"string","description":"Storage path for the document"},"upload_status":{"type":"string","description":"Current upload status of the document"},"hash":{"type":"string","description":"SHA256 hash of the document file"},"comment":{"type":"string","nullable":true,"description":"Optional comment associated with the document"},"uploaded_by":{"type":"string","description":"Identifier of the user who uploaded the document"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the document was deleted (ISO 8601 format)"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the document was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the document was last updated (ISO 8601 format)"}}}}}}},"DocumentGetDownloadRequest":{"type":"object","required":["document_id"],"description":"Request to get a presigned download URL for a document","properties":{"document_id":{"type":"string","description":"The document identifier with d_ prefix"}}},"DocumentGetDownloadResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"document":{"type":"object","required":["download_url"],"description":"Document download information","properties":{"download_url":{"type":"string","format":"uri","description":"Presigned S3 URL for downloading the document. This URL is temporary and will expire."}}}}}}},"DocumentDeleteRequest":{"type":"object","required":["document_id"],"description":"Request to soft delete a document","properties":{"document_id":{"type":"string","description":"The document identifier with d_ prefix"}}},"DocumentDeleteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object for successful deletion (idempotent operation)"}}},"MbtrustCreateRequest":{"type":"object","required":["workflow_id","provisioning_sponsor"],"description":"Request to create a new account provisioning entity (Mbtrust)","properties":{"workflow_id":{"type":"string","description":"The workflow ID under which the account provisioning is created. The workflow must be of type ACCOUNT_PROVISIONING and in state STARTED."},"provisioning_sponsor":{"$ref":"#/components/schemas/AccountProvisioningSponsors"}}},"MbtrustCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"mbtrust":{"type":"object","properties":{"mbtrust_id":{"type":"string","description":"ID of the newly created mbtrust record"},"status":{"$ref":"#/components/schemas/AccountProvisioningEntityStatuses","description":"Current status of the mbtrust entity"}}}}}}},"MbtrustCanExecuteRequest":{"type":"object","required":["mbtrust_id"],"description":"Request to validate account provisioning entity requirements (Mbtrust)","properties":{"mbtrust_id":{"type":"string","description":"The Mbtrust Account provisioning entity id to validate."}}},"MbtrustCanExecuteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"can_execute":{"type":"boolean","description":"Whether the account provisioning integration can be executed."},"missing_requirements":{"type":"array","description":"List of missing requirements if the integration can not be executed.","items":{"type":"object","required":["code","entity_type","message"],"properties":{"code":{"$ref":"#/components/schemas/MbtrustMissingRequirements"},"entity_type":{"$ref":"#/components/schemas/MbtrustEntityTypes"},"entity_id":{"type":"string","nullable":true,"description":"ID of the specific entity that has missing requirements"},"message":{"type":"string","description":"Human-readable description of the missing requirement"},"related_methods":{"type":"array","nullable":true,"description":"API methods that may be relevant to resolve the requirement","items":{"type":"string"}},"related_endpoints":{"type":"array","nullable":true,"description":"API endpoints that may be relevant to resolve the requirement","items":{"type":"string"}},"fields":{"type":"array","nullable":true,"description":"Specific fields that are missing or required","items":{"type":"string"}}}}}}}}},"MbtrustExecuteRequest":{"type":"object","required":["mbtrust_id"],"description":"Request to execute account provisioning integration to Mbtrust.","properties":{"mbtrust_id":{"type":"string","description":"The Mbtrust Account provisioning entity id to execute."}}},"MbtrustExecuteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"mbtrust":{"type":"object","properties":{"mbtrust_id":{"type":"string","description":"ID of the mbtrust record that was executed"},"queued_operations":{"type":"array","description":"Account provisioning operations that have been queued for processing.","items":{"$ref":"#/components/schemas/AccountProvisioningOperations"}}}}}}}},"MbtrustGetRequest":{"type":"object","required":["mbtrust_id"],"description":"Request to retrieve the status of the Mbtrust account provisioning entity.","properties":{"mbtrust_id":{"type":"string","description":"The Mbtrust Account provisioning entity id to retrieve."}}},"MbtrustGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"mbtrust":{"type":"object","properties":{"mbtrust_id":{"type":"string","description":"ID of the mbtrust record that was executed"},"workflow_id":{"type":"string","description":"The ID for the Workflow."},"subject_record_id":{"type":"string","description":"The Subject Record associated with the Workflow."},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"execution_results":{"type":"array","description":"Account provisioning operations that have been executed.","items":{"$ref":"#/components/schemas/AccountProvisioningOperationResult"}}}}}}}},"WorkflowRequiredDocumentListRequestDocumentRequest":{"type":"object","required":["workflow_id"],"description":"Retrieve a list of all Document Request entities for a specified workflow.","properties":{"workflow_id":{"type":"string","description":"The identifier for the workflow starting with w_ prefix."},"filters":{"type":"object","description":"Optional filters to apply for the results.","properties":{"active":{"type":"boolean","description":"Filter by document request's fulfilled_at parameter."}}}}},"WorkflowRequiredDocumentListRequestDocumentResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"document_requests":{"type":"array","description":"An array of Document Request objects that contain information on all the Document Request submitted for the Workflow. If the Workflow has no Document Request objects, the array will be empty.","items":{"type":"object","properties":{"required_document_id":{"type":"string","description":"The unique identifier for Required Document Id."},"document_request_id":{"type":"string","description":"The unique identifier for Document Request Id."},"document_requested_by":{"type":"object","description":"Detailed information on the user who made the request.","properties":{"type":{"type":"string","description":"The role of the user who made the request."},"email":{"type":"string","description":"The email of the user who made the request."},"name":{"type":"string","description":"The name of the user who made the request."}}},"comment":{"type":"string","description":"The comment provided by the document requester. Will be null if no comment has been made yet."},"requested_at":{"type":"string","format":"date-time","description":"The timestamp when the request was made (ISO 8601 format)."},"fulfilled_at":{"type":"string","format":"date-time","description":"The timestamp when the request was fulfilled. (ISO 8601 format). Will be null if no decision has been made yet."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the request was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the request was updated (ISO 8601 format)"}}}}}}}},"MetadataLinksAddRequest":{"type":"object","required":["metadata_id","entity_ids"],"description":"Request to add links between a metadata detail and one or more entities.","properties":{"metadata_id":{"type":"string","description":"The ID of the metadata detail to link entities to","example":"md_123456789012"},"entity_ids":{"type":"array","description":"Array of entity IDs to link to the metadata. Valid prefixes are l (Location), p (Person), ba (Bank Account), b (Business)","items":{"type":"string","example":"p_123456789012"},"minItems":1}}},"MetadataLinksAddResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object on success"}}},"MetadataLinksRemoveRequest":{"type":"object","required":["metadata_id","entity_ids"],"description":"Request to remove links between a metadata detail and one or more entities.","properties":{"metadata_id":{"type":"string","description":"The ID of the metadata detail to remove entity links from","example":"md_123456789012"},"entity_ids":{"type":"array","description":"Array of entity IDs to unlink from the metadata. Valid prefixes are l (Location), p (Person), ba (Bank Account), b (Business)","items":{"type":"string","example":"p_123456789012"},"minItems":1}}},"MetadataLinksRemoveResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Empty object on success"}}},"MetadataLinksGetRequest":{"type":"object","required":["metadata_id"],"description":"Request to retrieve links of business, person, bank account and locations with metadata details.","properties":{"metadata_id":{"type":"string","description":"The ID of the metadata detail to retrieve entity linked ids from","example":"md_123456789012"}}},"MetadataLinksGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","description":"Object containing entity IDs linked to the metadata","properties":{"entity_ids":{"type":"array","description":"Array of entity IDs linked to this metadata. Valid prefixes are l (Location), p (Person), ba (Bank Account), b (Business)","items":{"type":"string"},"example":["p_123456789012","b_123456789012"]}}}}},"PropayCreateRequest":{"type":"object","required":["workflow_id","provisioning_sponsor"],"description":"Request to create a new account provisioning entity (Propay)","properties":{"workflow_id":{"type":"string","description":"The workflow ID under which the account provisioning is created. The workflow must be of type ACCOUNT_PROVISIONING and in state STARTED."},"provisioning_sponsor":{"$ref":"#/components/schemas/AccountProvisioningSponsors"}}},"PropayCreateResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"propay":{"type":"object","properties":{"propay_id":{"type":"string","description":"ID of the newly created propay record"},"status":{"$ref":"#/components/schemas/AccountProvisioningEntityStatuses","description":"Current status of the propay entity"}}}}}}},"PropayCanExecuteRequest":{"type":"object","required":["propay_id"],"description":"Request to validate account provisioning entity requirements (Propay)","properties":{"propay_id":{"type":"string","description":"The Propay Account provisioning entity id to validate."}}},"PropayCanExecuteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"can_execute":{"type":"boolean","description":"Whether the account provisioning integration can be executed."},"missing_requirements":{"type":"array","description":"List of missing requirements if the integration can not be executed.","items":{"type":"object","required":["code","entity_type","message"],"properties":{"code":{"$ref":"#/components/schemas/PropayMissingRequirements"},"entity_type":{"$ref":"#/components/schemas/PropayEntityTypes"},"entity_id":{"type":"string","nullable":true,"description":"ID of the specific entity that has missing requirements"},"message":{"type":"string","description":"Human-readable description of the missing requirement"},"related_methods":{"type":"array","nullable":true,"description":"API methods that may be relevant to resolve the requirement","items":{"type":"string"}},"related_endpoints":{"type":"array","nullable":true,"description":"API endpoints that may be relevant to resolve the requirement","items":{"type":"string"}},"fields":{"type":"array","nullable":true,"description":"Specific fields that are missing or required","items":{"type":"string"}}}}}}}}},"PropayExecuteRequest":{"type":"object","required":["propay_id"],"description":"Request to execute account provisioning integration to Propay.","properties":{"propay_id":{"type":"string","description":"The Propay Account provisioning entity id to execute."}}},"PropayExecuteResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"propay":{"type":"object","properties":{"propay_id":{"type":"string","description":"ID of the propay record that was executed"},"queued_operations":{"type":"array","description":"Account provisioning operations that have been queued for processing.","items":{"$ref":"#/components/schemas/AccountProvisioningOperations"}}}}}}}},"PropayGetRequest":{"type":"object","required":["propay_id"],"description":"Request to retrieve the status of the Propay account provisioning entity.","properties":{"propay_id":{"type":"string","description":"The Propay Account provisioning entity id to retrieve."}}},"PropayGetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaSuccessResponse"},"data":{"type":"object","properties":{"propay":{"type":"object","properties":{"propay_id":{"type":"string","description":"ID of the propay record that was executed"},"workflow_id":{"type":"string","description":"The ID for the Workflow."},"subject_record_id":{"type":"string","description":"The Subject Record associated with the Workflow."},"created_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"updated_at":{"type":"string","format":"date-time","description":"The date-time when the Workflow was last updated in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)."},"execution_results":{"type":"array","description":"Account provisioning operations that have been executed.","items":{"$ref":"#/components/schemas/AccountProvisioningOperationResult"}}}}}}}}}},"paths":{"/account.documentType.list":{"post":{"summary":"List Account Document Types","description":"Retrieve document types for a specific account with optional filtering.\n","operationId":"accountDocumentTypeList","tags":["Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDocumentTypeListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDocumentTypeListResponse"}}}},"400":{"$ref":"#/components/responses/AccountDocumentTypeListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error5XX"}}}},"/bankAccount.create":{"post":{"summary":"Create a Bank Account","description":"Create a Bank Account entity to capture financial account details.\n","operationId":"bankAccountCreate","tags":["Bank Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountCreateResponse"}}}},"400":{"$ref":"#/components/responses/BankAccountCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/bankAccount.delete":{"post":{"summary":"Delete a Bank Account","description":"Remove a Bank Account entity from a Subject Record.\n","operationId":"bankAccountDelete","tags":["Bank Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDeleteResponse"}}}},"400":{"$ref":"#/components/responses/BankAccountDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/bankAccount.get":{"post":{"summary":"Get Bank Account Details","description":"Retrieve comprehensive details about a specific Bank Account entity.\n","operationId":"bankAccountGet","tags":["Bank Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountGetResponse"}}}},"400":{"$ref":"#/components/responses/BankAccountGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/bankAccount.list":{"post":{"summary":"List Bank Accounts","description":"Retrieve a comprehensive list of all Bank Account entities within a Subject Record.\n","operationId":"bankAccountList","tags":["Bank Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountListResponse"}}}},"400":{"$ref":"#/components/responses/BankAccountListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/bankAccount.update":{"post":{"summary":"Update a Bank Account","description":"Update a Bank Account entity to modify financial account details.\n","operationId":"bankAccountUpdate","tags":["Bank Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountUpdateResponse"}}}},"400":{"$ref":"#/components/responses/BankAccountUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.addBankAccount":{"post":{"summary":"Add Bank Account to Business","description":"Associate a Bank Account entity with a specific Business entity.\n","operationId":"businessAddBankAccount","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/BusinessAddBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.addOwner":{"post":{"summary":"Add Owner to Business","description":"Associate a Person entity as an owner of a specific Business entity.\n","operationId":"businessAddOwner","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddOwnerRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddOwnerResponse"}}}},"400":{"$ref":"#/components/responses/BusinessAddOwnerErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.updateOwner":{"post":{"summary":"Update Business Owner to modify details","description":"Modify essential details for a Business Owner entity.\n","operationId":"businessUpdateOwner","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateOwnerRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateOwnerResponse"}}}},"400":{"$ref":"#/components/responses/BusinessUpdateOwnerErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.getOwner":{"post":{"summary":"Get Business Owner Details","description":"Retrieve comprehensive details of a Business Owner entity including the Person entity associated with the Business Owner.\n","operationId":"businessGetOwner","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetOwnerRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetOwnerResponse"}}}},"400":{"$ref":"#/components/responses/BusinessGetOwnerErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.create":{"post":{"summary":"Create a Business","description":"Create a Business entity to capture essential information about a company.\n","operationId":"businessCreate","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCreateResponse"}}}},"400":{"$ref":"#/components/responses/BusinessCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.update":{"post":{"summary":"Update a Business","description":"Update a Business entity to capture essential information about a company.\n","operationId":"businessUpdate","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateResponse"}}}},"400":{"$ref":"#/components/responses/BusinessUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.delete":{"post":{"summary":"Delete a Business","description":"Remove a Business entity from a Subject Record.\n","operationId":"businessDelete","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDeleteResponse"}}}},"400":{"$ref":"#/components/responses/BusinessDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.get":{"post":{"summary":"Get Business Details","description":"Retrieve comprehensive details about a specific Business entity.\n\nWhen `verbose=true` is specified, the response will include additional related entities:\n- `business_bank_accounts`: Array of associated bank accounts\n- `business_owners`: Array of associated business owners\n- `sales_info`: Sales information object (if sales_info_id is present)\n\nAll verbose arrays are ordered by created_at in descending order (newest first).\n","operationId":"businessGet","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetResponse"}}}},"400":{"$ref":"#/components/responses/BusinessGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.getBankAccount":{"post":{"summary":"Get Business Bank Account","description":"Retrieve details of a specific Bank Account associated with a Business entity.\n","operationId":"businessGetBankAccount","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/BusinessGetBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.listBankAccounts":{"post":{"summary":"List Business Bank Accounts","description":"Retrieve a comprehensive list of all Bank Accounts associated with a specific Business entity.\nUse the `verbose` parameter to include detailed bank account information.\nUse the `show_sensitive_data` parameter to include unredacted sensitive information.\n","operationId":"businessListBankAccounts","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListBankAccountsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListBankAccountsResponse"}}}},"400":{"$ref":"#/components/responses/BusinessListBankAccountsErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.listOwners":{"post":{"summary":"List Business Owners","description":"Retrieve a comprehensive list of all owners associated with a specific Business entity.\nUse `verbose=true` to include detailed person information for each owner.\nUse `show_sensitive_data=true` to include unmasked sensitive fields (requires verbose=true for person data).\n","operationId":"businessListOwners","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListOwnersRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListOwnersResponse"}}}},"400":{"$ref":"#/components/responses/BusinessListOwnersErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.removeBankAccount":{"post":{"summary":"Remove Bank Account from Business","description":"Remove the association between a Bank Account and a Business entity.\n","operationId":"businessRemoveBankAccount","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/BusinessRemoveBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.updateBankAccount":{"post":{"summary":"Update Business Bank Account","description":"Update the account purposes for a specific Bank Account associated with a Business entity.\n","operationId":"businessUpdateBankAccount","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdateBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/BusinessUpdateBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.removeOwner":{"post":{"summary":"Remove Owner from Business","description":"Remove an ownership relationship between a Person and a Business entity.\n","operationId":"businessRemoveOwner","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveOwnerRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveOwnerResponse"}}}},"400":{"$ref":"#/components/responses/BusinessRemoveOwnerErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.addLocation":{"post":{"summary":"Add Location to Business","description":"Associate a Location entity as a location of a specific Business entity.\n","operationId":"businessAddLocation","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddLocationRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAddLocationResponse"}}}},"400":{"$ref":"#/components/responses/BusinessAddLocationErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.getLocation":{"post":{"summary":"Get Business Location Details","description":"Retrieve comprehensive details of a Business Location entity including the Location entity associated with the Business Location.\n","operationId":"businessGetLocation","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetLocationRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGetLocationResponse"}}}},"400":{"$ref":"#/components/responses/BusinessGetLocationErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.listLocations":{"post":{"summary":"List Business Locations","description":"Retrieve a comprehensive list of all locations associated with a specific Business entity.\nUse `verbose=true` to include detailed location information for each location.\nUse `show_sensitive_data=true` to include unmasked sensitive fields (requires verbose=true for location data).\n","operationId":"businessListLocations","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListLocationsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessListLocationsResponse"}}}},"400":{"$ref":"#/components/responses/BusinessListLocationsErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.removeLocation":{"post":{"summary":"Remove Location from Business","description":"Remove a location relationship between a Location and a Business entity.\n","operationId":"businessRemoveLocation","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveLocationRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRemoveLocationResponse"}}}},"400":{"$ref":"#/components/responses/BusinessRemoveLocationErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.salesInfo.create":{"post":{"summary":"Create Sales Information for Business","description":"Create sales information for a Business entity, including card brands, sales methods, and sales amounts.\n","operationId":"businessSalesInfoCreate","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoCreateResponse"}}}},"400":{"$ref":"#/components/responses/BusinessSalesInfoCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.salesInfo.delete":{"post":{"summary":"Delete Sales Information","description":"Delete sales information associated with a business.\n","operationId":"businessSalesInfoDelete","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoDeleteResponse"}}}},"400":{"$ref":"#/components/responses/BusinessSalesInfoDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.salesInfo.get":{"post":{"summary":"Get Sales Information","description":"Retrieve sales information details for a business.\n","operationId":"businessSalesInfoGet","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoGetResponse"}}}},"400":{"$ref":"#/components/responses/BusinessSalesInfoGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/business.salesInfo.update":{"post":{"summary":"Update Sales Information for Business","description":"Update sales information for a Business entity, including card brands, sales methods, and sales amounts.\n","operationId":"businessSalesInfoUpdate","tags":["Business"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSalesInfoUpdateResponse"}}}},"400":{"$ref":"#/components/responses/BusinessSalesInfoUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/document.create":{"post":{"summary":"Create a Document","description":"Create a new document and get presigned upload URL for file upload.\n","operationId":"documentCreate","tags":["Document"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateResponse"}}}},"400":{"$ref":"#/components/responses/DocumentCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"500":{"$ref":"#/components/responses/Error5XX"}}}},"/document.list":{"post":{"summary":"List Documents for Subject Record","description":"Retrieve a list of all documents within a Subject Record.\n","operationId":"documentList","tags":["Document"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentListResponse"}}}},"400":{"$ref":"#/components/responses/DocumentListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/document.getDownload":{"post":{"summary":"Get Presigned Download URL for Document","description":"Generate a presigned URL for downloading a document.\n","operationId":"documentGetDownload","tags":["Document"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGetDownloadRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGetDownloadResponse"}}}},"400":{"$ref":"#/components/responses/DocumentGetDownloadErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"404":{"$ref":"#/components/responses/DocumentGetDownloadErrorResponse"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/document.get":{"post":{"summary":"Get Document Details","description":"Retrieve detailed information about a specific document.\n","operationId":"documentGet","tags":["Document"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGetResponse"}}}},"400":{"$ref":"#/components/responses/DocumentGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"404":{"$ref":"#/components/responses/DocumentGetErrorResponse"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/document.delete":{"post":{"summary":"Soft Delete a Document","description":"Soft delete a document. This is an idempotent operation that returns success even if the document is already deleted.\n\nOnly the document uploader can delete a document. Documents with accepted fulfillments cannot be deleted.\n","operationId":"documentDelete","tags":["Document"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDeleteResponse"}}}},"400":{"$ref":"#/components/responses/DocumentDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"404":{"$ref":"#/components/responses/DocumentDeleteErrorResponse"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.create":{"post":{"summary":"Create a Location","description":"Create a Location entity to capture detailed information about a specific location.\n","operationId":"locationCreate","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCreateResponse"}}}},"400":{"$ref":"#/components/responses/LocationCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.get":{"post":{"summary":"Get Location Details","description":"Retrieve comprehensive details about a specific Location entity.\n","operationId":"locationGet","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetResponse"}}}},"400":{"$ref":"#/components/responses/LocationGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.list":{"post":{"summary":"List Locations","description":"Retrieve a comprehensive list of all Location entities within a Subject Record.\n","operationId":"locationList","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListResponse"}}}},"400":{"$ref":"#/components/responses/LocationListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.update":{"post":{"summary":"Update a Location","description":"Update a Location entity to capture detailed information about a specific location.\n","operationId":"locationUpdate","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateResponse"}}}},"400":{"$ref":"#/components/responses/LocationUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.delete":{"post":{"summary":"Delete a Location","description":"Remove a Location entity from a Subject Record.\n","operationId":"locationDelete","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDeleteResponse"}}}},"400":{"$ref":"#/components/responses/LocationDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.addBankAccount":{"post":{"summary":"Add Bank Account to Location","description":"Associate a Bank Account entity with a specific Location entity.\n","operationId":"locationAddBankAccount","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationAddBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationAddBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/LocationAddBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.getBankAccount":{"post":{"summary":"Get LocationBankAccount Details","description":"Retrieve comprehensive details about a specific LocationBankAccount entity.\n","operationId":"locationGetBankAccount","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/LocationGetBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.listBankAccounts":{"post":{"summary":"List LocationBankAccounts","description":"Retrieve a comprehensive list of all LocationBankAccount entities associated with a Location.\n","operationId":"locationListBankAccounts","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListBankAccountsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListBankAccountsResponse"}}}},"400":{"$ref":"#/components/responses/LocationListBankAccountsErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/location.removeBankAccount":{"post":{"summary":"Remove Bank Account from Location","description":"Remove the association between a Bank Account and a Location entity.\n","operationId":"locationRemoveBankAccount","tags":["Location"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRemoveBankAccountRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRemoveBankAccountResponse"}}}},"400":{"$ref":"#/components/responses/LocationRemoveBankAccountErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.type.define":{"post":{"summary":"Define Metadata Type","description":"Define a new metadata type and its fields definition.\n","operationId":"metadataTypeDefine","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataTypeDefineRequest"}}}},"responses":{"200":{"description":"Successful operation - metadata detail created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataTypeDefineResponse"}}}},"400":{"$ref":"#/components/responses/MetadataTypeDefineErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.create":{"post":{"summary":"Create a Metadata Entry","description":"Create a Metadata entry to capture metadata type details.\n","operationId":"metadataCreate","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCreateResponse"}}}},"400":{"$ref":"#/components/responses/MetadataCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.update":{"post":{"summary":"Update a Metadata Entry","description":"Update the details of an existing metadata Entry.\n","operationId":"metadataUpdate","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataUpdateResponse"}}}},"400":{"$ref":"#/components/responses/MetadataUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.get":{"post":{"summary":"Get Metadata Entity Details","description":"Retrieve comprehensive details about a specific Metadata entity.\n","operationId":"metadataGet","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataGetResponse"}}}},"400":{"$ref":"#/components/responses/MetadataGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.list":{"post":{"summary":"Get List of MetadataDetails entities for Subject Record","description":"Retrieve a list of MetadataDetails entities associated with a specific Subject Record.\n","operationId":"metadataList","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataListResponse"}}}},"400":{"$ref":"#/components/responses/MetadataListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.create":{"post":{"summary":"Create a Person","description":"Create a Person entity to capture detailed information about an individual.\n","operationId":"personCreate","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreateResponse"}}}},"400":{"$ref":"#/components/responses/PersonCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.update":{"post":{"summary":"Update a Person","description":"Update an existing Person entity with new information.\n","operationId":"personUpdate","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonUpdateResponse"}}}},"400":{"$ref":"#/components/responses/PersonUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.delete":{"post":{"summary":"Delete a Person","description":"Remove a Person entity from a Subject Record.\n","operationId":"personDelete","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonDeleteResponse"}}}},"400":{"$ref":"#/components/responses/PersonDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.get":{"post":{"summary":"Get Person Details","description":"Retrieve comprehensive details about a specific Person entity.\n","operationId":"personGet","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonGetResponse"}}}},"400":{"$ref":"#/components/responses/PersonGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.list":{"post":{"summary":"List Persons","description":"Retrieve a comprehensive list of all Person entities within a Subject Record.\n","operationId":"personList","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonListResponse"}}}},"400":{"$ref":"#/components/responses/PersonListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.issuedIdentifier.create":{"post":{"summary":"Create a Person Issued Identifier","description":"Create an Issued Identifier for a Person to capture detailed information about an individual's issued identifiers.\n","operationId":"personIssuedIdentifierCreate","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierCreateResponse"}}}},"400":{"$ref":"#/components/responses/PersonIssuedIdentifierCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.issuedIdentifier.get":{"post":{"summary":"Get Person Issued Identifier Details","description":"Retrieve comprehensive details about a specific Person Issued Identifier entity.\n","operationId":"personIssuedIdentifierGet","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierGetResponse"}}}},"400":{"$ref":"#/components/responses/PersonIssuedIdentifierGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.issuedIdentifier.list":{"post":{"summary":"List Person Issued Identifiers","description":"Retrieve a comprehensive list of all Person Issued Identifier entities within a Subject Record.\n","operationId":"personIssuedIdentifierList","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierListResponse"}}}},"400":{"$ref":"#/components/responses/PersonIssuedIdentifierListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.issuedIdentifier.update":{"post":{"summary":"Update a Person Issued Identifier","description":"Update an existing Person Issued Identifier entity with new information.\n","operationId":"personIssuedIdentifierUpdate","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierUpdateResponse"}}}},"400":{"$ref":"#/components/responses/PersonIssuedIdentifierUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/person.issuedIdentifier.delete":{"post":{"summary":"Delete a Person Issued Identifier","description":"Remove a Person Issued Identifier entity from a Subject Record.\n","operationId":"personIssuedIdentifierDelete","tags":["Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonIssuedIdentifierDeleteResponse"}}}},"400":{"$ref":"#/components/responses/PersonIssuedIdentifierDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/subjectRecord.create":{"post":{"summary":"Create a Subject Record","description":"Create a Subject Record to serve as a container for related entity information.\n","operationId":"subjectRecordCreate","tags":["Subject Record"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordCreateResponse"}}}},"400":{"$ref":"#/components/responses/SubjectRecordCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/subjectRecord.get":{"post":{"summary":"Get a Subject Record","description":"Retrieve a Subject Record and optionally its related entities when verbose mode is enabled.\n","operationId":"subjectRecordGet","tags":["Subject Record"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordGetResponse"}}}},"400":{"$ref":"#/components/responses/Error4XX"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/subjectRecord.delete":{"post":{"summary":"Delete a Subject Record","description":"Remove a Subject Record entity and its associations.\n","operationId":"subjectRecordDelete","tags":["Subject Record"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordDeleteResponse"}}}},"400":{"$ref":"#/components/responses/SubjectRecordDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/subjectRecord.list":{"post":{"summary":"Retrieve Subject Records","description":"Retrieve a comprehensive list of all Subject Record entities within an account.\nThis method returns all Subject Record entities associated with an account.\n","operationId":"subjectRecordList","tags":["Subject Record"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectRecordListResponse"}}}},"400":{"$ref":"#/components/responses/SubjectRecordListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.key.create":{"post":{"summary":"Create a Webhook Encryption Key","description":"Create a new SharedSecret (encryption key) for securing webhook payloads sent to your endpoints.\nEach account can have multiple keys, but only one can be active at a time.\nThe SharedSecret is returned in plaintext exactly once during creation - store it securely.\n","operationId":"webhookKeyCreate","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyCreateResponse"}}}},"400":{"$ref":"#/components/responses/WebhookKeyCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.key.get":{"post":{"summary":"Get Webhook Key Details","description":"Retrieve information about a specific webhook key, including its current status,\ncreation date, and activation/deletion timestamps if applicable.\nThe SharedSecret itself is never returned for security reasons.\n","operationId":"webhookKeyGet","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyGetResponse"}}}},"400":{"$ref":"#/components/responses/WebhookKeyGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.key.activate":{"post":{"summary":"Activate a Webhook Encryption Key","description":"Activate a webhook key, making it the current active key for encrypting webhook payloads.\nOnly one key can be active at a time per account. When you activate a new key,\nany previously active key is automatically moved to DELETED status.\n","operationId":"webhookKeyActivate","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyActivateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookKeyActivateResponse"}}}},"400":{"$ref":"#/components/responses/WebhookKeyActivateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.config.create":{"post":{"summary":"Create a Webhook Configuration","description":"Create a new webhook configuration for receiving webhook notifications.\nEach account can have multiple webhook endpoint configurations.\nThe URL must use HTTPS protocol for security.\nWhen the maximum limit is reached, delete unused configurations before adding new ones.\n","operationId":"webhookConfigCreate","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigCreateResponse"}}}},"400":{"$ref":"#/components/responses/WebhookConfigCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.config.get":{"post":{"summary":"Get Webhook Configuration Details","description":"Retrieve information about a specific webhook configuration, including its URL,\ncreation date, and last update timestamp.\n","operationId":"webhookConfigGet","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigGetResponse"}}}},"400":{"$ref":"#/components/responses/WebhookConfigGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.config.update":{"post":{"summary":"Update a Webhook Configuration","description":"Update an existing webhook configuration's URL.\nThe new URL must use HTTPS protocol and must not already exist for the account.\nDeleted configurations cannot be updated.\n","operationId":"webhookConfigUpdate","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigUpdateResponse"}}}},"400":{"$ref":"#/components/responses/WebhookConfigUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.config.list":{"post":{"summary":"List Webhook Configurations","description":"Retrieve a list of all active webhook configurations for an account.\nDeleted configurations are not included in the response.\n","operationId":"webhookConfigList","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigListResponse"}}}},"400":{"$ref":"#/components/responses/WebhookConfigListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/webhook.config.delete":{"post":{"summary":"Delete a Webhook Configuration","description":"Delete an existing webhook configuration. Once deleted, the configuration\ncannot be recovered or updated. Webhooks will no longer be sent to this endpoint.\n","operationId":"webhookConfigDelete","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigDeleteResponse"}}}},"400":{"$ref":"#/components/responses/WebhookConfigDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.canComplete":{"post":{"summary":"Check if Workflow Can Complete","description":"Check if a workflow has all required information to be completed and identify any missing requirements.\n","operationId":"workflowCanComplete","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCanCompleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCanCompleteResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowCanCompleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.complete":{"post":{"summary":"Complete a Workflow","description":"Complete a workflow that has all required information and is ready for finalization.\n","operationId":"workflowComplete","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCompleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCompleteResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowCompleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.create":{"post":{"summary":"Create a Workflow","description":"Create a Workflow to enable structured processing of data in a Subject Record.\n","operationId":"workflowCreate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCreateResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.get":{"post":{"summary":"Get Workflow Details","description":"Retrieve comprehensive information about a specific Workflow.\n","operationId":"workflowGet","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowGetResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.update":{"post":{"summary":"Update a Workflow","description":"Update an existing Workflow to modify the details.\n","operationId":"workflowUpdate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowUpdateResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.pricing.calculate":{"post":{"summary":"Calculate Workflow Pricing","description":"Calculate pricing for a workflow based on its current state and requirements.\n","operationId":"workflowPricingCalculate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPricingCalculateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPricingCalculateResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowPricingCalculateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.pricing.get":{"post":{"summary":"Get Workflow Pricing","description":"Retrieve detailed pricing information for a workflow including fees, rates, and pricing model details.\n","operationId":"workflowPricingGet","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPricingGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPricingGetResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowPricingGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.start":{"post":{"summary":"Start a Workflow","description":"Start a previously created workflow to begin processing.\n","operationId":"workflowStart","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowStartRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowStartResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowStartErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.list":{"post":{"summary":"List Workflows","description":"Retrieve a comprehensive list of all Workflow entities within a Subject Record.\n","operationId":"workflowList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.delete":{"post":{"summary":"Delete a Workflow","description":"Remove a Workflow entity.\n","operationId":"workflowDelete","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeleteResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.list":{"post":{"summary":"List Required Documents for Workflow","description":"List required documents for a workflow with optional filtering by status.\n","operationId":"workflowRequiredDocumentList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.calculate":{"post":{"summary":"Calculate Required Documents for Workflow","description":"Calculate and generate required documents for a workflow.\n","operationId":"workflowRequiredDocumentCalculate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentCalculateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentCalculateResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentCalculateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.batchAdd":{"post":{"summary":"Add Multiple Required Documents to Workflow","description":"Add multiple required documents to a workflow in a single batch operation.\n","operationId":"workflowRequiredDocumentBatchAdd","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentBatchAddRequest"}}}},"responses":{"200":{"description":"Batch operation completed - returns individual results for each document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentBatchAddResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentBatchAddErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.batchRequestDocument":{"post":{"summary":"Request Files for Multiple Required Documents","description":"Request document files for multiple required documents in a batch operation.\n","operationId":"workflowRequiredDocumentBatchRequestDocument","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentBatchRequestDocumentRequest"}}}},"responses":{"200":{"description":"Batch operation completed - returns individual results for each document request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentBatchRequestDocumentResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentBatchRequestDocumentErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.fulfillment.batchAdd":{"post":{"summary":"Add Multiple Fulfillments to Required Documents","description":"Add multiple fulfillments in a batch operation. Links documents to required documents with decision status.\n","operationId":"workflowRequiredDocumentFulfillmentBatchAdd","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentBatchAddRequest"}}}},"responses":{"200":{"description":"Batch operation completed - returns individual results for each fulfillment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentBatchAddResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentFulfillmentBatchAddErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.fulfillment.list":{"post":{"summary":"List Fulfillments for Required Document","description":"List all fulfillments for a required document with optional filtering by decision status and document upload status.\n","operationId":"workflowRequiredDocumentFulfillmentList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentListRequest"}}}},"responses":{"200":{"description":"Successful operation - returns array of fulfillments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentFulfillmentListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.fulfillment.update":{"post":{"summary":"Update Fulfillment Decision Status","description":"Update the decision status of a fulfillment.\n","operationId":"workflowRequiredDocumentFulfillmentUpdate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentUpdateRequest"}}}},"responses":{"200":{"description":"Successful operation - returns empty data object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentUpdateResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentFulfillmentUpdateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.fulfillment.delete":{"post":{"summary":"Delete a Fulfillment","description":"Delete a fulfillment. Idempotent operation that returns success even if already deleted.\n","operationId":"workflowRequiredDocumentFulfillmentDelete","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentDeleteRequest"}}}},"responses":{"200":{"description":"Successful operation - returns empty object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentDeleteResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentFulfillmentDeleteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.fulfillment.addComment":{"post":{"summary":"Add Comment to Fulfillment","description":"Add a comment to a fulfillment for documentation and review purposes.\n","operationId":"workflowRequiredDocumentFulfillmentAddComment","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentAddCommentRequest"}}}},"responses":{"200":{"description":"Successful operation - returns comment ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentFulfillmentAddCommentResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentFulfillmentAddCommentErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.event.list":{"post":{"summary":"List Workflow Required Document Events","description":"List workflow required document events with optional filtering by fulfillment.\n","operationId":"workflowRequiredDocumentEventList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentEventsListRequest"}}}},"responses":{"200":{"description":"Successful operation - returns array of events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentEventsListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentEventsListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"404":{"$ref":"#/components/responses/WorkflowRequiredDocumentEventListNotFoundErrorResponse"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.requiredDocument.listRequestDocument":{"post":{"summary":"Retrieve a list of all Document Request entities for a specified workflow.","description":"Retrieves all document request records for a workflow, showing which documents have been requested, requester details, comments, and timestamps. Optionally filter to show only unfulfilled requests. Use to track outstanding and fulfilled document requests for auditing or workflow management.\n","operationId":"workflowRequiredDocumentListRequestDocument","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentListRequestDocumentRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRequiredDocumentListRequestDocumentResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowRequiredDocumentDocumentRequestListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.defenseDocument.generate":{"post":{"summary":"Generate Defense Document for Workflow","description":"Generate a defense document for a Business Underwriting workflow.\nThis endpoint creates a comprehensive document containing all decision data and\nsupporting information for the workflow.\n\n**Requirements:**\n- Workflow must be of type `BUSINESS_UNDERWRITING`\n- Workflow must not be in `ENDED` state\n","operationId":"workflowDefenseDocumentGenerate","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"The unique identifier of the workflow","pattern":"^w_[a-zA-Z0-9]{22}$","example":"w_1234567890123456789012"}}}}}},"responses":{"200":{"description":"Defense document generation initiated successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MetaSuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"defense_document":{"type":"object","properties":{"defense_document_id":{"type":"string","description":"The unique identifier of the generated defense document","pattern":"^wdd_[a-zA-Z0-9]{22}$","example":"wdd_1234567890123456789012"}}}}}}}]}}}},"400":{"description":"Bad Request - Workflow validation errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","INVALID_WORKFLOW_TYPE","WORKFLOW_ENDED"]},"message":{"type":"string"}}}}}]}}}},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.defenseDocument.list":{"post":{"summary":"List Defense Documents for Workflow","description":"Retrieve a comprehensive list of all defense documents associated with a specific workflow.\nReturns defense documents with their current status and metadata.\n\n**Requirements:**\n- Workflow must be of type `BUSINESS_UNDERWRITING`\n- Workflow must exist and be accessible by the authenticated account\n","operationId":"workflowDefenseDocumentList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"The unique identifier of the workflow","pattern":"^w_[a-zA-Z0-9]{22}$","example":"w_1234567890123456789012"}}}}}},"responses":{"200":{"description":"List of defense documents retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MetaSuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"defense_documents":{"type":"array","description":"Array of defense documents for the workflow","items":{"type":"object","properties":{"defense_document_id":{"type":"string","description":"The unique identifier of the defense document","pattern":"^wdd_[a-zA-Z0-9]{22}$","example":"wdd_1234567890123456789012"},"status":{"type":"string","enum":["in_progress","completed","failed"],"description":"Current status of the defense document","example":"completed"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the defense document was created","example":"2025-11-19T18:25:19.514Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the defense document was last updated","example":"2025-11-19T18:25:47.252Z"}}}}}}}}]}}}},"400":{"description":"Bad Request - Workflow validation errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","INVALID_WORKFLOW_TYPE"]},"message":{"type":"string"}}}}}]}}}},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.defenseDocument.getDownload":{"post":{"summary":"Get Defense Document Download URL","description":"Generate a presigned download URL for a completed defense document.\nThe URL provides secure, time-limited access to download the defense document file.\n\n**Requirements:**\n- Defense document must exist and be accessible by the authenticated account\n- Defense document must have status `completed`\n- Defense document must have an associated document file\n","operationId":"workflowDefenseDocumentGetDownload","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["defense_document_id"],"properties":{"defense_document_id":{"type":"string","description":"The unique identifier of the defense document","pattern":"^wdd_[a-zA-Z0-9]{22}$","example":"wdd_1234567890123456789012"}}}}}},"responses":{"200":{"description":"Download URL generated successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MetaSuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"defense_document":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","description":"Presigned URL for downloading the defense document file (expires after limited time)","example":"https://s3.amazonaws.com/mock-bucket/mock-document.pdf?expires=3600"}}}}}}}]}}}},"400":{"description":"Bad Request - Defense document validation errors","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorResponseTemplate"},{"type":"object","properties":{"errors":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","ENTITY_NOT_FOUND","SYSTEM_RULE_VIOLATION","SYSTEM_ERROR"]},"message":{"type":"string"},"sub_code":{"type":"string","enum":["DEFENSE_DOCUMENT_FAILED","DEFENSE_DOCUMENT_IN_PROGRESS"]}}}}}]}}}},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.agreement.list":{"post":{"summary":"List signed agreements for Workflow","description":"List signed agreements for a workflow.\n","operationId":"workflowAgreementList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowAgreementListRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowAgreementListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowAgreementListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.agreement.getDownload":{"post":{"summary":"Get download URL for signed agreement in Workflow","description":"Get the download URL for a signed agreement in a workflow.\n","operationId":"workflowAgreementGetDownload","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowAgreementGetDownloadRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowAgreementGetDownloadResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowAgreementGetDownloadErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.applicationSummary.getDownload":{"post":{"summary":"Download Application Summary Document","description":"Retrieve a presigned download URL for the application summary document associated with a workflow.\nThe workflow must be in an ended state and have a completed application summary document available.\n","operationId":"workflowApplicationSummaryGetDownload","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"The unique identifier for the workflow","example":"w_validRecordIdExample"}}}}}},"responses":{"200":{"description":"Successful operation - Returns presigned download URL","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS"},"version":{"type":"string","example":"2025-03-24"},"trace_id":{"type":"string","example":"trc_random-uuid"}}},"data":{"type":"object","properties":{"application_summary":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","description":"Presigned S3 URL for downloading the application summary PDF document","example":"https://s3.amazonaws.com/mock-bucket/mock-summary.pdf?expires=3600"}}}}}}}}}},"400":{"$ref":"#/components/responses/WorkflowApplicationSummaryGetDownloadErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.underwritingDecision.list":{"post":{"summary":"List Underwriting Decisions for Workflow","description":"Retrieve a comprehensive list of all underwriting decisions of the workflow.\n","operationId":"workflowUnderwritingDecisionList","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"The unique identifier for the workflow","example":"w_validRecordIdExample"}}}}}},"responses":{"200":{"description":"Successful operation - Returns list of underwriting decisions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowUnderwritingDecisionListResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowUnderwritingDecisionListErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/workflow.underwritingDecision.get":{"post":{"summary":"Get Underwriting Decision Detail","description":"Retrieve a comprehensive detail of the underwriting decision.\n","operationId":"workflowUnderwritingDecisionGet","tags":["Workflow"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["underwriting_decision_id"],"properties":{"underwriting_decision_id":{"type":"string","description":"The unique identifier for the underwriting decision","example":"da6d218c-0758-412b-aa72-192b14746929"}}}}}},"responses":{"200":{"description":"Successful operation - Returns underwriting decision detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowUnderwritingDecisionGetResponse"}}}},"400":{"$ref":"#/components/responses/WorkflowUnderwritingDecisionGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/mbtrust.create":{"post":{"summary":"Create Account provisioning entity for mbtrust","description":"Create Account provisioning entity for mbtrust.\n","operationId":"mbtrustCreate","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustCreateResponse"}}}},"400":{"$ref":"#/components/responses/MbtrustCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/mbtrust.canExecute":{"post":{"summary":"Validates if the mbtrust account provisioning entity can be executed.","description":"Validates if the mbtrust account provisioning entity can be executed. This means that all the requirements for mbtrust should be fulfilled on the business information.\n","operationId":"mbtrustCanExecute","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustCanExecuteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustCanExecuteResponse"}}}},"400":{"$ref":"#/components/responses/MbtrustCanExecuteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/mbtrust.execute":{"post":{"summary":"Initiates MBTrust account provisioning execution.","description":"Initiates MBTrust account provisioning execution. This operation should be executed only after the mbtrust.canExecute method returns true.\n","operationId":"mbtrustExecute","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustExecuteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustExecuteResponse"}}}},"400":{"$ref":"#/components/responses/MbtrustExecuteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/mbtrust.get":{"post":{"summary":"Retrieves details of the mbtrust account provisioning entity.","description":"Retrieves details of the mbtrust account provisioning entity and its operations.\n","operationId":"mbtrustGet","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MbtrustGetResponse"}}}},"400":{"$ref":"#/components/responses/MbtrustGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.links.add":{"post":{"summary":"Add Metadata Links","description":"Links one or more entities (Person, Business, Bank Account, or Location) to a metadata detail record.\nAll entities must belong to the same subject record as the metadata detail.\nEntities that are already linked will be skipped without error.\n","operationId":"metadataLinksAdd","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksAddRequest"},"examples":{"single_entity":{"summary":"Link to a single entity","value":{"metadata_id":"md_123456789012","entity_ids":["p_123456789012"]}},"multiple_entities":{"summary":"Link to multiple entities","value":{"metadata_id":"md_123456789012","entity_ids":["p_123456789012","b_123456789012","ba_123456789012","l_123456789012"]}}}}}},"responses":{"200":{"description":"Successful operation - links created for entities not already linked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksAddResponse"}}}},"400":{"$ref":"#/components/responses/MetadataLinksAddErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.links.get":{"post":{"summary":"Retrieve Metadata Links entity ids","description":"Links from one or more entities (Person, Business, Bank Account, or Location) to a metadata detail record.\n","operationId":"metadataLinksGet","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksGetRequest"}}}},"responses":{"200":{"description":"Successful operation - links for entities linked to metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksGetResponse"}}}},"400":{"$ref":"#/components/responses/MetadataLinksGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/metadata.links.remove":{"post":{"summary":"Remove Metadata Links","description":"Removes links between a metadata detail record and one or more entities (Person, Business, Bank Account, or Location).\nAll entities must belong to the same subject record as the metadata detail.\nOnly existing links will be removed; non-existent links will be ignored without error.\n","operationId":"metadataLinksRemove","tags":["Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksRemoveRequest"},"examples":{"single_entity":{"summary":"Unlink a single entity","value":{"metadata_id":"md_123456789012","entity_ids":["p_123456789012"]}},"multiple_entities":{"summary":"Unlink multiple entities","value":{"metadata_id":"md_123456789012","entity_ids":["p_123456789012","b_123456789012","ba_123456789012","l_123456789012"]}}}}}},"responses":{"200":{"description":"Successful operation - existing links removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataLinksRemoveResponse"}}}},"400":{"$ref":"#/components/responses/MetadataLinksRemoveErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/propay.create":{"post":{"summary":"Create Account provisioning entity for propay","description":"Create Account provisioning entity for propay.\n","operationId":"propayCreate","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayCreateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayCreateResponse"}}}},"400":{"$ref":"#/components/responses/PropayCreateErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/propay.canExecute":{"post":{"summary":"Validates if the propay account provisioning entity can be executed.","description":"Validates if the propay account provisioning entity can be executed. This means that all the requirements for propay should be fulfilled on the business information.\n","operationId":"propayCanExecute","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayCanExecuteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayCanExecuteResponse"}}}},"400":{"$ref":"#/components/responses/PropayCanExecuteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/propay.execute":{"post":{"summary":"Initiates ProPay account provisioning execution.","description":"Initiates ProPay account provisioning execution. This operation should be executed only after the propay.canExecute method returns true.\n","operationId":"propayExecute","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayExecuteRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayExecuteResponse"}}}},"400":{"$ref":"#/components/responses/PropayExecuteErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}},"/propay.get":{"post":{"summary":"Retrieves details of the propay account provisioning entity.","description":"Retrieves details of the propay account provisioning entity and its operations.\n","operationId":"propayGet","tags":["Account Provisioning"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayGetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropayGetResponse"}}}},"400":{"$ref":"#/components/responses/PropayGetErrorResponse"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"4XX":{"$ref":"#/components/responses/Error4XX"},"5XX":{"$ref":"#/components/responses/Error5XX"}}}}}}