{"openapi":"3.1.0","info":{"title":"Clients Service","description":"Backoffice Service API for the INFONITE project.","termsOfService":"https://www.lucual18.es/terms","contact":{"name":"CATGRID","url":"https://www.example.es/","email":"adler.marmol@gmail.com"},"license":{"name":"Copyright (C) 2024 Adler Marmol & Camila Molina"},"version":"2026.5.300"},"servers":[{"url":"https://test-clients.catgrid.tech/","description":"Clients Service Server"}],"paths":{"/api/executions/init/v1/parametrized":{"post":{"tags":["Execution Handling"],"summary":"Initiate an execution","description":"Initiates an execution.","operationId":"clients_executions_init_api_executions_init_v1_parametrized_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execute"}}},"required":true},"responses":{"202":{"description":"**202 Accepted**<br>Execution Acceptance Response","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"**400 Bad Request**<br>The request is not valid due to incorrect configurations","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"404":{"description":"**404 Not Found**<br>Engine not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>There is already an execution for this client/app/customer/engine combination","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"503":{"description":"**503 Service Unavailable**<br>Engine is not available","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/executions/init/v1/tokenized":{"post":{"tags":["Execution Handling"],"summary":"Tokenized execution","description":"With a previously generated token, initiates an execution. The execution features are restricted to the features scoped in the original token. You can use less features but not include new-ones that where not included in the original token.","operationId":"clients_executions_tokenized_init_api_executions_init_v1_tokenized_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizedExecute"}}},"required":true},"responses":{"202":{"description":"**202 Accepted**<br>Direct Execution Acceptance Response","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Tokenization is not allowed for any reason","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"**400 Bad Request**<br>The request is not valid due to incorrect configurations","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"423":{"description":"**423 Locked**<br>Tokenization is temporarily disabled for this credential. Detailed information is provided in the body of the response. Check the token status for more information.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"404":{"description":"**404 Not Found**<br>Token or engine not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>There is already an execution for this client/app/customer/engine combination","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}},"503":{"description":"**503 Service Unavailable**<br>Engine is not available","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/executions/handler/v1/{execution_id}":{"head":{"tags":["Execution Handling"],"summary":"Execution State (HTTP Code)","description":"Fetch the state of an execution. This endpoint is used to get updates about the state of the execution.<br/>_This endpoint only returns the status code with an empty body._","operationId":"clients_executions_handler_head_api_executions_handler_v1__execution_id__head","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Execution ended","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution is still processing","headers":{}},"404":{"description":"**404 Not Found**<br>Execution not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"423":{"description":"**423 Locked**<br>Action required. Some action is required to continue the execution, please check the execution state for more information about the information to provide.","headers":{}}}},"get":{"tags":["Execution Handling"],"summary":"Execution State Details","description":"Details of the execution state. Used to check where the execution has ended, or if it's still processing. Also informs if some action is required to continue, or the errors that occurred during the execution ifit ended with errors.","operationId":"clients_executions_handler_get_api_executions_handler_v1__execution_id__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Execution ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionStateSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution is still processing","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionStateSchema"}}}},"400":{"description":"**300 Multiple Choices**<br>Bad or missing configurations","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionStateSchema"}}}},"404":{"description":"**404 Not Found**<br>Execution not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"423":{"description":"**423 Locked**<br>Action required. Some action is required to continue the execution.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionRequiredStateSchema"}}}}}},"put":{"tags":["Execution Handling"],"summary":"Resume an execution","description":"Resumes an execution that was paused due to an action required. Only executions that are in the `ACTION_REQUIRED` status can be resumed.<br/>","operationId":"clients_executions_handler_put_api_executions_handler_v1__execution_id__put","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeExecutionSchema","description":"Required fields to resume the execution","examples":[{"username":"john.doe@example.com"}]}}}},"responses":{"202":{"description":"**202 Accepted**<br>Partial Execution Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"**400 Bad Request**<br>Execution is not waiting for an action","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"**404 Not Found**<br>Execution not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"**503 Service Unavailable**<br>Engine is not available","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineExecutionSchema"}}}}}}},"/api/executions/handler/v1/{execution_id}/abort":{"delete":{"tags":["Execution Handling"],"summary":"Abort execution","description":"Aborts an execution.","operationId":"clients_executions_handler_abort_api_executions_handler_v1__execution_id__abort_delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"204":{"description":"**204 No Content**<br>Aborted Successfully","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"304":{"description":"**304 Not Modified**<br>Execution already closed","headers":{}},"404":{"description":"**404 Not Found**<br>Execution not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>Execution cannot be aborted","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/executions/handler/v1/{execution_id}/delete":{"delete":{"tags":["Execution Handling"],"summary":"Delete execution","description":"Delete an execution. Only closed executions can be deleted.","operationId":"clients_executions_handler_delete_api_executions_handler_v1__execution_id__delete_delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"204":{"description":"**204 No Content**<br>Deleted Successfully","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"**404 Not Found**<br>Execution not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>Execution cannot be deleted","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/executions/results/{execution_id}/customer/v1/profile":{"get":{"tags":["Customer Profile Data"],"summary":"Customer Profile","description":"Fetch the customer profile obtained during the execution.","operationId":"client_execution_results_customer_profile_api_executions_results__execution_id__customer_v1_profile_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Customer Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProfileSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/customer/v1/contracts":{"get":{"tags":["Customer Profile Data"],"summary":"Customer Contracts","description":"Fetch the customer contracts obtained during the execution.","operationId":"client_execution_results_customer_contracts_api_executions_results__execution_id__customer_v1_contracts_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Customer Contracts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericSourceContractSchema"},"title":"Response Client Execution Results Customer Contracts Api Executions Results  Execution Id  Customer V1 Contracts Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/accounts":{"get":{"tags":["Financial Data"],"summary":"Accounts","description":"Fetch the accounts obtained during the execution","operationId":"client_execution_results_financial_accounts_api_executions_results__execution_id__financial_v1_accounts_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CurrentAccountSchema"},"description":"Current accounts retrieved by the engine","title":"Response Client Execution Results Financial Accounts Api Executions Results  Execution Id  Financial V1 Accounts Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/cards":{"get":{"tags":["Financial Data"],"summary":"Cards","description":"Fetch the cards obtained during the execution","operationId":"client_execution_results_financial_cards_api_executions_results__execution_id__financial_v1_cards_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Cards","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/CreditCardSchema"},{"$ref":"#/components/schemas/DebitCardSchema"},{"$ref":"#/components/schemas/PrepaidCardSchema"}]},"description":"Cards retrieved by the engine","title":"Response Client Execution Results Financial Cards Api Executions Results  Execution Id  Financial V1 Cards Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/deposits":{"get":{"tags":["Financial Data"],"summary":"Deposits","description":"Fetch the deposits obtained during the execution","operationId":"client_execution_results_financial_deposits_api_executions_results__execution_id__financial_v1_deposits_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Deposits","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/TimeDepositSchema"},{"$ref":"#/components/schemas/SavingsGoalSchema"}]},"description":"Deposits retrieved by the engine","title":"Response Client Execution Results Financial Deposits Api Executions Results  Execution Id  Financial V1 Deposits Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/loans":{"get":{"tags":["Financial Data"],"summary":"Loans","description":"Fetch the loans obtained during the execution","operationId":"client_execution_results_financial_loans_api_executions_results__execution_id__financial_v1_loans_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Loans","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PersonalLoanSchema"},{"$ref":"#/components/schemas/MortgageSchema"}]},"description":"Loans retrieved by the engine","title":"Response Client Execution Results Financial Loans Api Executions Results  Execution Id  Financial V1 Loans Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/investments/accounts":{"get":{"tags":["Financial Data"],"summary":"Investment Accounts","description":"Fetch the investment accounts obtained during the execution","operationId":"client_execution_results_financial_investment_accounts_api_executions_results__execution_id__financial_v1_investments_accounts_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Investment Accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvestmentAccountSchema"},"description":"Investment accounts retrieved by the engine","title":"Response Client Execution Results Financial Investment Accounts Api Executions Results  Execution Id  Financial V1 Investments Accounts Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/investments/stocks":{"get":{"tags":["Financial Data"],"summary":"Stocks","description":"Fetch the stocks obtained during the execution","operationId":"client_execution_results_financial_investment_stocks_api_executions_results__execution_id__financial_v1_investments_stocks_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Stocks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvestmentStockSchema"},"description":"Investment stocks retrieved by the engine","title":"Response Client Execution Results Financial Investment Stocks Api Executions Results  Execution Id  Financial V1 Investments Stocks Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/investments/funds":{"get":{"tags":["Financial Data"],"summary":"Funds","description":"Fetch the funds obtained during the execution","operationId":"client_execution_results_financial_investment_funds_api_executions_results__execution_id__financial_v1_investments_funds_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Funds","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvestmentFundSchema"},"description":"Investment funds retrieved by the engine","title":"Response Client Execution Results Financial Investment Funds Api Executions Results  Execution Id  Financial V1 Investments Funds Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/investments/pensions":{"get":{"tags":["Financial Data"],"summary":"Pension Plans","description":"Fetch the pension plans obtained during the execution","operationId":"client_execution_results_financial_investment_pensions_api_executions_results__execution_id__financial_v1_investments_pensions_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Pension Plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PensionPlanSchema"},"description":"Pension Plans retrieved by the engine","title":"Response Client Execution Results Financial Investment Pensions Api Executions Results  Execution Id  Financial V1 Investments Pensions Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/direct-debits":{"get":{"tags":["Financial Data"],"summary":"Direct Debits","description":"Fetch the Direct Debits obtained during the execution","operationId":"client_execution_results_financial_direct_debits_api_executions_results__execution_id__financial_v1_direct_debits_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Direct Debits","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SEPADirectDebitSchema"},"description":"Direct Debits retrieved by the engine","title":"Response Client Execution Results Financial Direct Debits Api Executions Results  Execution Id  Financial V1 Direct Debits Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/direct-debits/{direct_debit_id}/last-attachment":{"get":{"tags":["Financial Data"],"summary":"Direct Debit Attachment","description":"Fetch's the last direct debit receipt attachment obtained during the execution","operationId":"client_execution_results_financial_direct_debits_last_attachment_api_executions_results__execution_id__financial_v1_direct_debits__direct_debit_id__last_attachment_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"},{"name":"direct_debit_id","in":"path","required":true,"schema":{"type":"string","description":"Direct Debit ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Direct Debit Id"},"description":"Direct Debit ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Direct Debit last attachment","headers":{},"content":{"*/*":{"transfer-encoding":"chunked"}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}},"404":{"description":"**404 Not Found**<br>Direct Debit not found","headers":{}}}}},"/api/executions/results/{execution_id}/financial/v1/global-position":{"get":{"tags":["Financial Data"],"summary":"Financial Global Position","description":"Constructs a global view of the financial products of the execution","operationId":"client_execution_results_financial_global_position_api_executions_results__execution_id__financial_v1_global_position_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Global Position","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialGlobalPositionSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution still processing","headers":{}}}}},"/api/executions/results/{execution_id}/commercial/v1/supplier-invoices":{"get":{"tags":["Commercial Data"],"summary":"Supplier Invoices","description":"Fetch the supplier invoices obtained during the execution.","operationId":"client_execution_results_commercial_supplier_invoices_api_executions_results__execution_id__commercial_v1_supplier_invoices_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Supplier Invoices","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SupplierInvoiceSchema"},"title":"Response Client Execution Results Commercial Supplier Invoices Api Executions Results  Execution Id  Commercial V1 Supplier Invoices Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/commercial/v1/supplier-invoices/{invoice_id}/attachment":{"get":{"tags":["Commercial Data"],"summary":"Supplier Invoice Attachment","description":"Fetch the supplier invoice attachment obtained during the execution","operationId":"client_execution_results_commercial_supplier_invoices_attachment_api_executions_results__execution_id__commercial_v1_supplier_invoices__invoice_id__attachment_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","description":"Invoice ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Invoice Id"},"description":"Invoice ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Supplier Invoice Attachment","headers":{},"content":{"*/*":{"transfer-encoding":"chunked"}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}},"404":{"description":"**404 Not Found**<br>Invoice not found","headers":{}}}}},"/api/executions/results/{execution_id}/commercial/v1/client-invoices":{"get":{"tags":["Commercial Data"],"summary":"Client Invoices","description":"Fetch the client invoices obtained during the execution.","operationId":"client_execution_results_commercial_client_invoices_api_executions_results__execution_id__commercial_v1_client_invoices_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Client Invoices","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientInvoiceSchema"},"title":"Response Client Execution Results Commercial Client Invoices Api Executions Results  Execution Id  Commercial V1 Client Invoices Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/commercial/v1/client-invoices/{invoice_id}/attachment":{"get":{"tags":["Commercial Data"],"summary":"Client Invoice Attachment","description":"Fetch the client invoice attachment obtained during the execution","operationId":"client_execution_results_commercial_client_invoices_attachment_api_executions_results__execution_id__commercial_v1_client_invoices__invoice_id__attachment_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","description":"Invoice ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Invoice Id"},"description":"Invoice ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Client Invoice Attachment","headers":{},"content":{"*/*":{"transfer-encoding":"chunked"}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}},"404":{"description":"**404 Not Found**<br>Invoice not found","headers":{}}}}},"/api/executions/results/{execution_id}/cloud/v1/resources":{"get":{"tags":["Cloud Provider Data"],"summary":"Cloud Resources","description":"Fetch the cloud resources obtained from the execution.","operationId":"client_execution_results_cloud_resources_api_executions_results__execution_id__cloud_v1_resources_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Cloud Resource","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudResourceSchema"},"title":"Response Client Execution Results Cloud Resources Api Executions Results  Execution Id  Cloud V1 Resources Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/middlewares/u3x/bank_data_model":{"get":{"tags":["U3X Middleware"],"summary":"U3X Bank Data Model","description":"INFONITE to U3X Bank Data Model based on https://developer.unnax.com/docs/aggregation/adgn536x88k1i-bank-data-model","operationId":"client_execution_results_middlewares_u3x_bank_data_model_api_executions_results__execution_id__middlewares_u3x_bank_data_model_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"},{"name":"currency","in":"query","required":false,"schema":{"type":"string","description":"Currency to fetch","format":"currency","examples":["EUR","USD","GBP"],"default":"EUR","title":"Currency"},"description":"Currency to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Bank Data Model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/U3XBankDataModelSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution still processing","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/labor-check":{"get":{"tags":["Public Administration Data"],"summary":"Labor Check Information","description":"Fetch the Labor Check Information obtained during the execution.","operationId":"client_execution_results_public_labor_check_api_executions_results__execution_id__public_v1_labor_check_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Labor Check Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGSSSpainLaborCheckSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/labor-check/salary-estimator":{"get":{"tags":["Public Administration Data"],"summary":"Labor Check - Salary Estimator","description":"Given the labor check information, makes a salary estimation","operationId":"client_execution_results_public_labor_check_salary_estimation_api_executions_results__execution_id__public_v1_labor_check_salary_estimator_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Salary estimation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGSSSpainLaborCheckSalaryEstimationSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/pensions":{"get":{"tags":["Public Administration Data"],"summary":"Public Pensions Information","description":"Fetch the Public Pensions obtained during the execution.","operationId":"client_execution_results_public_pensions_api_executions_results__execution_id__public_v1_pensions_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Public Pension Information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TGSSSpainPublicPensionSchema"},"title":"Response Client Execution Results Public Pensions Api Executions Results  Execution Id  Public V1 Pensions Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/tax/individual/yearly":{"get":{"tags":["Public Administration Data"],"summary":"Yearly individuals taxes","description":"Fetch's the yearly tax situation for individuals.","operationId":"client_execution_results_public_yearly_individual_tax_api_executions_results__execution_id__public_v1_tax_individual_yearly_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Yearly Individuals Tax","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/YearlyPersonalTaxSituationSchema"},"title":"Response Client Execution Results Public Yearly Individual Tax Api Executions Results  Execution Id  Public V1 Tax Individual Yearly Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/driver/data":{"get":{"tags":["Public Administration Data"],"summary":"Driver Data","description":"Fetch's the driver data for the person.","operationId":"client_execution_results_public_driver_data_api_executions_results__execution_id__public_v1_driver_data_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Driver data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EUDriverDataSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/driver/vehicles":{"get":{"tags":["Public Administration Data"],"summary":"Owned Vehicles","description":"Fetch's the vehicles owned by the person","operationId":"client_execution_results_public_driver_data_api_executions_results__execution_id__public_v1_driver_vehicles_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Owned vehicles","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EUOwnedVehicleSchema"},"title":"Response Client Execution Results Public Driver Data Api Executions Results  Execution Id  Public V1 Driver Vehicles Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/academic/higher-education-degrees":{"get":{"tags":["Public Administration Data"],"summary":"Higher education degrees","description":"Fetch's the higher education degrees","operationId":"client_execution_results_public_higher_education_degrees_api_executions_results__execution_id__public_v1_academic_higher_education_degrees_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Higher education degrees","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HigherEducationSchema"},"title":"Response Client Execution Results Public Higher Education Degrees Api Executions Results  Execution Id  Public V1 Academic Higher Education Degrees Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/academic/secondary-education":{"get":{"tags":["Public Administration Data"],"summary":"Secondary education","description":"Fetch's the secondary education","operationId":"client_execution_results_public_secondary_education_api_executions_results__execution_id__public_v1_academic_secondary_education_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Secondary education degrees","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecondaryEducationSchema"},"title":"Response Client Execution Results Public Secondary Education Api Executions Results  Execution Id  Public V1 Academic Secondary Education Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/public/v1/properties/es":{"get":{"tags":["Public Administration Data"],"summary":"Secondary education","description":"Fetch's the properties that the user owns in Spain","operationId":"client_execution_results_public_es_owned_properties_api_executions_results__execution_id__public_v1_properties_es_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Spanish owned properties","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ESOwnedPropertySchema"},"title":"Response Client Execution Results Public Es Owned Properties Api Executions Results  Execution Id  Public V1 Properties Es Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Feature still processing","headers":{}},"204":{"description":"**204 No Content**<br>Product not available","headers":{}}}}},"/api/executions/results/{execution_id}/attachments/v1/all":{"get":{"tags":["Execution Attachments"],"summary":"List all attachments","description":"Retrieves all attachments for the specified execution.","operationId":"client_execution_results_attachments_all_api_executions_results__execution_id__attachments_v1_all_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch.","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch."}],"responses":{"200":{"description":"**200 OK**<br>List of retrieved attachments.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttachmentSchema"},"title":"Response Client Execution Results Attachments All Api Executions Results  Execution Id  Attachments V1 All Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution still processing.","headers":{}}}}},"/api/executions/results/{execution_id}/attachments/v1/{attachment_id}":{"get":{"tags":["Execution Attachments"],"summary":"Download attachment","description":"Downloads the specified attachment file.","operationId":"client_execution_results_attachments_download_api_executions_results__execution_id__attachments_v1__attachment_id__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","description":"Execution ID to fetch.","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Execution Id"},"description":"Execution ID to fetch."},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","description":"Attachment ID to download.","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Attachment Id"},"description":"Attachment ID to download."}],"responses":{"200":{"description":"**200 OK**<br>Attachment file.","headers":{},"content":{"*/*":{"transfer-encoding":"chunked"}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"**202 Accepted**<br>Execution still processing.","headers":{}},"404":{"description":"**404 Not Found**<br>Attachment not found.","headers":{}}}}},"/api/executions/t10n":{"put":{"tags":["Tokenization Handling"],"summary":"Exchange a ticket","description":"Exchange a temporary ticket to obtain an engine execution token without exposing client credentials","operationId":"clients_t10n_tokens_exchange_api_executions_t10n_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeTokenRequest"}}},"required":true},"responses":{"200":{"description":"**200 OK**<br>Token acceptance response","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exchange"}}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Tokenization is not allowed","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/executions/t10n/{token_id}":{"get":{"tags":["Tokenization Handling"],"summary":"Token Status","description":"Exchange a temporary ticket to obtain an engine execution token without exposing client credentials","operationId":"clients_t10n_tokens_status_api_executions_t10n__token_id__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"token_id","in":"path","required":true,"schema":{"type":"string","description":"Token ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Token Id"},"description":"Token ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Token Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCredentialResponse"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"**404 Not Found**<br>Token not fond","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Tokenization Handling"],"summary":"Delete Token","description":"Deletes a token from the system","operationId":"clients_t10n_tokens_delete_api_executions_t10n__token_id__delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"token_id","in":"path","required":true,"schema":{"type":"string","description":"Token ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Token Id"},"description":"Token ID to fetch"}],"responses":{"204":{"description":"**204 No Content**<br>Deleted Successfully","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"304":{"description":"**304 Not Modified**<br>Already for deletion","headers":{}},"404":{"description":"**404 Not Found**<br>Token not fond","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/config/hooks/list":{"get":{"tags":["[CONFIG] Webhooks"],"summary":"List App Hooks","description":"Hooks are a way to trigger callbacks from your INFONITE application to a URL of your choice. This can be useful for integrating with third-party services or triggering actions in your own application.","operationId":"clients_applications_config_hooks_list_api_config_hooks_list_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"array","uniqueItems":true,"items":{"const":"event","type":"string"},"maxItems":10,"description":"Sort by the specified fields. Accepts multiple values and the order can be specified with a \"-\" prefix","examples":[["-name"]],"default":["event"],"title":"Sort"},"description":"Sort by the specified fields. Accepts multiple values and the order can be specified with a \"-\" prefix"}],"responses":{"200":{"description":"**200 OK**<br>List of App Hooks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientAppHooksConfigSchema"},"title":"Response Clients Applications Config Hooks List Api Config Hooks List Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/config/hooks/update":{"patch":{"tags":["[CONFIG] Webhooks"],"summary":"Create/Update App Hook","description":"### Application Webhooks\n\nHooks are a way to trigger callbacks from your INFONITE application to a URL of your choice. \nThis can be useful for integrating with third-party services or triggering actions in your own application.\n\n### Creating a Webhook\n\nYou should crate a webhook for each event you want to listen to. Available events are:\n\n- `queued`: Raised when a new job is added to the queue.\n- `started`: Raised when an execution has started.\n- `action_required`: Raised when an action is required from the user, such as a MFA.\n- `ended`: Raised when an execution has ended.\n- `auth_ended`: Special event raised  when the authentication process has ended, so you can asume the user credentials are valid.\n\nAlso you should provide the URL, the http method and the producer of the event you are listening to *`Root` should be enough for most cases*.\n\nFor example, to create a webhook triggered on execution end, you  should create a hook like this one:\n\n```json\n{\n    \"event\": \"ended\",\n    \"producer\": \"Root\",\n    \"enabled\": true,\n    \"method\": \"POST\",\n    \"base_url\": \"https://www.example.com/trace\"\n}\n```\n\n### Receiving a Webhook\n\nGiven the example above, INFONITE will send a POST request to `https://www.example.com/trace` \nwhen an execution ends, with the following payload:\n\n```json\n{\n  \"app_id\": \"<your_app_id>\",\n  \"customer_id\": \"<customer_id>\",\n  \"execution_id\": \"<execution_id>\",\n  \"locking_hash\": \"<credentials_dedup_key>\",\n  \"producer\": \"Root\",\n  \"event\": \"ended\",\n  \"date\": \"<date_the_event_was_raised>\",\n  \"status_reason\": \"<status_reason_at_the_moment_of_the_event>\"\n}\n```","operationId":"clients_applications_config_hooks_patch_api_config_hooks_update_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update"}}},"required":true},"responses":{"204":{"description":"**204 No Content**<br>Updated successfully","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/config/hooks/delete":{"delete":{"tags":["[CONFIG] Webhooks"],"summary":"Delete App Hook","description":"Deletes the given app hook configuration","operationId":"clients_applications_config_hooks_delete_api_config_hooks_delete_delete","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete"}}},"required":true},"responses":{"204":{"description":"**204 No Content**<br>Deleted successfully","headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"304":{"description":"**304 Not Modified**<br>Does not exist","headers":{}},"404":{"description":"**404 Not Found**<br>App not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/config/engines/list":{"get":{"tags":["Engines Marketplace"],"summary":"List Engines","description":"List available engines for the current application","operationId":"clients_marketplace_list_api_config_engines_list_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"markets","in":"query","required":false,"schema":{"type":"array","uniqueItems":true,"items":{"type":"string","format":"country","examples":["ES","US"]},"description":"Filter by markets, if multiple values are provided, the result will be the engines that match any of the markets. If no value is provided, all markets will be returned","title":"Markets"},"description":"Filter by markets, if multiple values are provided, the result will be the engines that match any of the markets. If no value is provided, all markets will be returned"},{"name":"features","in":"query","required":false,"schema":{"type":"array","uniqueItems":true,"items":{"enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"type":"string","title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"},"description":"Filter by features. use with `features_mode` to specify how to filter the features","title":"Features"},"description":"Filter by features. use with `features_mode` to specify how to filter the features"},{"name":"features_mode","in":"query","required":false,"schema":{"enum":["and","or"],"type":"string","description":"Mode to filter the features, `or` will return engines that match any of the features, `and` will return engines that match all the features","default":"and","title":"Features Mode"},"description":"Mode to filter the features, `or` will return engines that match any of the features, `and` will return engines that match all the features"},{"name":"main_category","in":"query","required":false,"schema":{"enum":["financial","public","commercial","cloud","other"],"type":"string","title":"Main Category","description":"Engine main category\nAllowed values are:\n - `financial`: Financial Institution\n- `public`: Public Administration Institution\n- `commercial`: Commercial Institution\n- `cloud`: Cloud Provider\n- `other`: Other"},"description":"Filter by engine main category. If not informed, all categories will be returned"},{"name":"is_online","in":"query","required":false,"schema":{"type":"boolean","description":"If specified, filter by online/offline. If not specified, all items will be returned","title":"Is Online"},"description":"If specified, filter by online/offline. If not specified, all items will be returned"}],"responses":{"200":{"description":"**200 OK**<br>List of available engines for the current application. This endpoint only shows engines that are available for the current application and ready to be executed:\n - The engine is enabled for the current client/application\n - The engine is enabled for the current application environment\n - The engine has a release candidate\n - The engine is online\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MarketPlaceEngineSchema"},"title":"Response 200 Clients Marketplace List Api Config Engines List Get"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/config/engines/{engine_reference}":{"get":{"tags":["Engines Marketplace"],"summary":"Show Engine Details","description":"Show the given engine's information","operationId":"executions_marketplace_engine_information_api_config_engines__engine_reference__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"engine_reference","in":"path","required":true,"schema":{"type":"string","description":"Engine to fetch","title":"Engine Reference","format":"engine-reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"description":"Engine to fetch"}],"responses":{"200":{"description":"**200 OK**<br>Engine detailed information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketPlaceEngineDetailsSchema"}}},"headers":{}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","example":"0.006551027297973633","schema":{"type":"number"}},"x-request-id":{"description":"Unique identifier for the request","example":"644599da47847b79c03cc94f","schema":{"type":"string"}},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","example":"5","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","example":"4","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","example":"1614625200","schema":{"type":"integer"}}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"**404 Not Found**<br>Engine not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"**404 Not Found**<br>Engine is not available","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/config/app":{"get":{"summary":"Current Application","description":"Show the current app's information<br><br>**Required roles:** `super:super` `internal:admin` `internal:support` `internal:developer`","operationId":"clients_applications_config_app_info_api_config_app_get","responses":{"200":{"description":"**200 OK**<br>App information","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAppSchema"}}}},"default":{"description":"**Defaults**<br>Default response information for all status codes","headers":{"x-process-time":{"description":"Time spent (in seconds) processing the request","schema":{"type":"number"},"example":"0.006551027297973633"},"x-request-id":{"description":"Unique identifier for the request","schema":{"type":"string"},"example":"644599da47847b79c03cc94f"},"x-ratelimit-limit":{"description":"Maximum number of requests that can be made in a period of time","schema":{"type":"integer"},"example":"5"},"x-ratelimit-remaining":{"description":"Number of requests remaining in the current period of time","schema":{"type":"integer"},"example":"4"},"x-ratelimit-reset":{"description":"Time (in timestamp format) when the rate limit will reset","schema":{"type":"integer"},"example":"1614625200"}}},"500":{"description":"**500 Internal Server Error**<br>Server got itself in trouble","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"**422 Unprocessable Content**<br>A validation error occurred. *See the response body for details*.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"**429 Too Many Requests**<br>The user has sent too many requests in a given amount of time (\"rate limiting\")","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"**401 Unauthorized**<br>No permission -- see authorization schemes","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"**403 Forbidden**<br>Request forbidden -- authorization will not help","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}}},"components":{"schemas":{"AccountHolderSchema":{"properties":{"role":{"type":"string","enum":["unknown","holder","authorized","beneficiary","other"],"title":"FinancialHolderRole","description":"Holder Role"},"name":{"type":"string","title":"Name","description":"Holder name"},"identifier":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"Holder identifier"},"current_customer":{"type":"boolean","title":"Current Customer","description":"Is current customer?"}},"type":"object","required":["role"],"title":"Financial Account Holder"},"AccountTransactionSchema":{"properties":{"type":{"type":"string","enum":["unknown","opening","closure","credit","debit","default"],"title":"FinancialTransactionType","description":"Transaction type"},"status":{"type":"string","enum":["unknown","pending","booked","cancelled","failed","reversed"],"title":"FinancialTransactionStatus","description":"Transaction status"},"category":{"type":"string","enum":["expenses::to categorize::unclassified","expenses::household::other household","expenses::household::rent","expenses::household::mortgage","expenses::household::utilities","expenses::household::communications","expenses::household::insurance & fees","expenses::household::services","expenses::home improvement::other home improvement","expenses::home improvement::renovation & repairs","expenses::home improvement::furniture & interior","expenses::home improvement::garden & outdoor","expenses::food & drinks::other food & drinks","expenses::food & drinks::groceries & supermarket","expenses::food & drinks::dining out","expenses::food & drinks::coffee & snacks","expenses::food & drinks::alcohol & tobacco","expenses::transport::other transport","expenses::transport::car & fuel","expenses::transport::public transport","expenses::transport::flights","expenses::transport::taxi & ride-share","expenses::shopping::other shopping","expenses::shopping::clothes & accessories","expenses::shopping::electronics & gadgets","expenses::shopping::hobby & sports equipment","expenses::shopping::books & games","expenses::shopping::gifts","expenses::leisure & entertainment::other leisure & entertainment","expenses::leisure & entertainment::culture events","expenses::leisure & entertainment::hobbies, sports & fitness","expenses::leisure & entertainment::hotels & vacation","expenses::leisure & entertainment::lottery & betting","expenses::health & beauty::other health & beauty","expenses::health & beauty::pharmacy","expenses::health & beauty::medical","expenses::health & beauty::beauty & personal care","expenses::health & beauty::optician & dentist","expenses::financial & organizations::other financial expenses","expenses::financial & organizations::credit obligations","expenses::financial & organizations::fees & charges","expenses::financial & organizations::public dues","expenses::other::other expenses","expenses::other::education","expenses::other::charity","expenses::other::associations","expenses::other::pets","expenses::other::kids","expenses::other::cash withdrawals","expenses::other::transfers","expenses::other::family pension/alimony","income::to categorize::unclassified","income::income::other income","income::income::salary & payroll","income::income::passive income","income::income::pension","income::income::subsidies & grants","income::income::tax refunds","income::income::transfers","income::income::cash deposit","income::income::received gifts","null::to categorize::unclassified","null::null::other not computable","null::null::card adjustment","null::null::card payment","null::null::investments","null::null::internal & self transfers"],"title":"FinancialTransactionCategory","description":"Transaction category. Transactions are classified based on their context and nature. The categorization is only applied if data enrichment is enabled for your current application. Otherwise, this field will be filled with a generic category based on  the transaction amount. \n Contact support for more information."},"operation_date":{"type":"string","format":"date","title":"Operation Date","description":"Represents the exact moment a transaction was initiated or authorized, regardless of when it was recorded or had an effect on the balance. For instance, if a purchase was made using a credit card, the operation_date would be the date of that purchase, even if the transaction was processed or reflected in the account on subsequent dates."},"value_date":{"type":"string","format":"date","title":"Value Date","description":"The date on which the transaction effectively impacts an account balance. It determines when interests or other time-based considerations might commence. Even though a transaction might be logged or authorized on a different date, the value_date signifies the point when it truly reflects on the account’s funds."},"amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Transaction amount"},"balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Account balance after the transaction"},"descriptions":{"items":{"type":"string"},"type":"array","title":"Descriptions","description":"Original transaction descriptions"},"provider_id":{"type":"string","title":"Provider Id","description":"Unique ID for the transaction in the provider system"},"reference":{"type":"string","title":"Reference","description":"Transaction reference"},"payee":{"$ref":"#/components/schemas/EntitySchema","description":"Payee information, if available"},"payer":{"$ref":"#/components/schemas/EntitySchema","description":"Payer information, if available"},"merchant":{"$ref":"#/components/schemas/EntitySchema","description":"Merchant information, if available"}},"type":"object","required":["type","status","category"],"title":"Financial Account Transaction"},"ActionRequiredStateSchema":{"properties":{"producer":{"anyOf":[{"type":"string","const":"Root","title":"Root","description":"Allowed value: `Root` Produced by the authentication phase"},{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"}],"title":"Producer","description":"Action Producer"},"status_reason":{"type":"string","enum":["PENDING_PARAMETERS","MFA_REQUIRED","INPUT_REQUIRED"],"title":"ActionRequiredReason","description":"Action required reason\nAllowed values are:\n - `PENDING_PARAMETERS`: The execution is waiting for user input of parameters\n- `MFA_REQUIRED`: The execution is waiting for user to solve a MFA challenge\n- `INPUT_REQUIRED`: The execution is waiting for dynamic input from the user"},"status_message":{"type":"string","title":"Status Message","description":"Execution status message"},"authentication_status":{"anyOf":[{"type":"string","const":"not-performed","title":"not-performed","description":"Authentication is not performed. Allowed value: `not-performed`"},{"type":"string","enum":["AUTH_OK","INCORRECT_CREDENTIALS","INCORRECT_MFA","DUPLICATED_SESSION","FRIEZED_CREDENTIALS","BLOCKED_USER","MANUAL_INTERVENTION","CHANGE_PASSWORD","INCOMPATIBLE_ACCESS"],"title":"AuthenticationReason","description":"Reasons for an authentication error status\nAllowed values are:\n - `AUTH_OK`: Authenticated successfully\n- `INCORRECT_CREDENTIALS`: Authentication failed due to incorrect credentials\n- `INCORRECT_MFA`: Authentication failed due to incorrect MFA\n- `DUPLICATED_SESSION`: Authentication failed due to duplicated session\n- `FRIEZED_CREDENTIALS`: Authentication failed due to temporally locked credentials\n- `BLOCKED_USER`: Authentication failed due to blocked user\n- `MANUAL_INTERVENTION`: The source requests manual intervention to continue\n- `CHANGE_PASSWORD`: Authentication failed due to password change required\n- `INCOMPATIBLE_ACCESS`: Authentication failed due to incompatible access"},{"type":"string","enum":["UNHANDLED_AUTH_ERROR"],"title":"UnhandledAuthReason","description":"Reasons for an unhandled authentication error status\nAllowed values are:\n - `UNHANDLED_AUTH_ERROR`: Unhandled authentication error"}],"title":"Authentication Status","description":"Authentication status"},"running_time":{"type":"number","title":"Running Time","description":"Running time"},"total_elapsed_time":{"type":"number","title":"Total Elapsed Time","description":"Total elapsed time"},"form_schema":{"anyOf":[{"$ref":"#/components/schemas/MFARequiredFieldsGroupSchema"},{"$ref":"#/components/schemas/InputRequiredFieldsGroupSchema"}],"title":"Form Schema","description":"Parameters schema for the current engine in OpenAPI 3.0.3 Schema Object format. if `status_reason` is `PENDING_PARAMETERS`, the form schema is not provided, and you should use the standard parameters schema for the engine."},"payload_errors":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Payload Errors","description":"List of errors found during the validation of the parameters if any"},"date_created":{"type":"string","format":"datetime","title":"Date Created","description":"Date when the execution was accepted","examples":["2023-10-05T14:46:36.546596Z"]},"date_started":{"type":"string","format":"datetime","title":"Date Started","description":"Date when the execution was started","examples":["2023-10-05T14:46:36.546596Z"]},"date_ended":{"type":"string","format":"datetime","title":"Date Ended","description":"Date when the execution ended","examples":["2023-10-05T14:46:36.546596Z"]},"status_code":{"type":"string","const":"ACTION_REQUIRED","title":"Status Code","description":"Execution status code","readOnly":true},"is_closed":{"type":"boolean","title":"Is Closed","description":"Indicates if the execution is closed","readOnly":true}},"type":"object","required":["producer","status_reason","authentication_status","status_code","is_closed"],"title":"Action Required State"},"AddressSchema":{"properties":{"type":{"type":"string","enum":["billing","contact","delivery","private","other"],"title":"AddressType","description":"Type of address"},"title":{"type":"string","title":"Title","description":"Title of the address for informational purposes","examples":["Headquarter"]},"street":{"type":"string","title":"Street","description":"Street name and number","examples":["82236 Floyd Falls"]},"street_extra":{"type":"string","title":"Street Extra","description":"Extra information about the street","examples":["Suite 123"]},"municipality":{"type":"string","title":"Municipality","description":"Municipality name","examples":["Santiago"]},"city":{"type":"string","title":"City","description":"City name","examples":["New York"]},"state":{"type":"string","title":"State","description":"State Code"},"country":{"type":"string","format":"country","title":"Country","description":"Country Code","examples":["ES","US"]},"zip_code":{"type":"string","title":"Zip Code","description":"Zip code","examples":["12345"]}},"type":"object","title":"Address Model","description":"Model representing an address"},"AppEnvironment":{"type":"string","enum":["sandbox","production"],"title":"AppEnvironment"},"AppStatus":{"type":"string","enum":["pending","active","locked","archived"],"title":"AppStatus"},"AuthOrigin":{"type":"string","enum":["app-secret","user-token","session-token"],"title":"AuthOrigin","description":"Represent the authentication origin types as enumerated string values."},"BaseEngineConfigurationsSchema":{"properties":{"customer_interaction_available":{"type":"boolean","title":"Customer Interaction Available","description":"If true, the engine can run flows that require user interaction, such as MFA flows. ","default":false},"abort_on_error":{"type":"boolean","title":"Abort On Error","description":"If true, execution will be automatically aborted if an error in parameters or resume payloads is detected. \nIf false, the execution will expect a manual correction of the parameters or resume payloads.","default":false},"execution_timeout":{"type":"integer","maximum":1200.0,"minimum":60.0,"title":"Execution Timeout","description":"Maximum time in seconds that the execution can be running. If the execution exceeds this time, \nit will be automatically aborted.","default":1200},"unlock_protected_data":{"type":"boolean","title":"Unlock Protected Data","description":"If true, the engine can unlock MFA protected data.","default":false},"tokenized_access":{"type":"boolean","title":"Tokenized Access","description":"Enable tokenized access capabilities. Requires the capability `login:tokenized_access` enabled four the current app.","default":false}},"type":"object","title":"Base Engine Configurations","description":"Set of configurations that are common to all engines."},"BeneficiarySchema":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"Beneficiary identifier"},"name":{"type":"string","title":"Name","description":"Beneficiary name"},"account":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Beneficiary account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"tax_id":{"type":"string","title":"Tax Id","description":"Beneficiary tax ID"}},"type":"object","title":"Direct Debit Beneficiary"},"BusinessActivityLine":{"properties":{"payer_id":{"type":"string","title":"Payer Id","description":"Payer NIF"},"description":{"type":"string","title":"Description","description":"Description of the business activity"},"activity_code":{"type":"string","title":"Activity Code","description":"Activity code (IAE / NACE)"},"total_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total business income"},"tax_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Tax withheld from the activity"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["description","activity_code","total_income","tax_withheld","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Business Activity Line"},"BusinessIncome":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/BusinessActivityLine"},"type":"array","title":"Activities","description":"List of business activities"},"total_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total economic activities income"},"total_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total economic activities withheld"},"social_security_contributions":{"$ref":"#/components/schemas/CurrencyAmount","description":"Social security contributions paid"}},"type":"object","required":["activities","total_income","total_withheld","social_security_contributions"],"title":"Yearly Fiscal Data / Persons / Business Income"},"CadastralDownloadInfoSchema":{"properties":{"cn":{"type":"string","title":"Cn","description":"Class of nature."},"cp":{"type":"string","title":"Cp","description":"Province code."},"cm":{"type":"string","title":"Cm","description":"Municipality code."},"pc1":{"type":"string","title":"Pc1","description":"Cadastral plot 1."},"pc2":{"type":"string","title":"Pc2","description":"Cadastral plot 2."},"car":{"type":"string","title":"Car","description":"Cargo/charge identifier."},"cc1":{"type":"string","title":"Cc1","description":"Control character 1."},"cc2":{"type":"string","title":"Cc2","description":"Control character 2."},"cpo":{"type":"string","title":"Cpo","description":"Postal code."},"cpa":{"type":"string","title":"Cpa","description":"Postal code area."},"refCat":{"type":"string","title":"Refcat","description":"Full cadastral reference."}},"type":"object","title":"Catastral Download Info"},"CapitalGainLine":{"properties":{"issuer_id":{"type":"string","title":"Issuer Id","description":"Identifier of the issuer"},"issuer_name":{"type":"string","title":"Issuer Name","description":"Name of the issuer"},"broker_id":{"type":"string","title":"Broker Id","description":"Identifier of the broker"},"broker_name":{"type":"string","title":"Broker Name","description":"Name of the broker"},"asset_description":{"type":"string","title":"Asset Description","description":"Description of the asset sold"},"asset_type":{"type":"string","title":"Asset Type","description":"Type of asset (e.g., Shares, Crypto, Real Estate)"},"sale_date":{"type":"string","format":"date","title":"Sale Date","description":"Date of sale"},"sale_value":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total sale value (net of expenses)"},"sale_expenses":{"$ref":"#/components/schemas/CurrencyAmount","description":"Expenses associated with the sale"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["asset_description","asset_type","sale_value","sale_expenses","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Capital Gain Line"},"CapitalGains":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/CapitalGainLine"},"type":"array","title":"Lines","description":"List of capital gain operations"}},"type":"object","required":["lines"],"title":"Yearly Fiscal Data / Persons / Capital Gains"},"CapitalIncome":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/CapitalIncomeLine"},"type":"array","title":"Lines","description":"List of capital income sources"},"total_gross":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total gross capital income"},"total_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total tax withheld from capital income"},"total_penalization":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total penalization"},"total_expenses":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total deductible expenses"}},"type":"object","required":["lines","total_gross","total_withheld","total_penalization","total_expenses"],"title":"Yearly Fiscal Data / Persons / Capital Income"},"CapitalIncomeLine":{"properties":{"provider_id":{"type":"string","title":"Provider Id","description":"Identifier of the financial entity (NIF/CIF)"},"provider_name":{"type":"string","title":"Provider Name","description":"Name of the financial entity"},"account_number":{"type":"string","title":"Account Number","description":"Account number or IBAN"},"asset_type":{"type":"string","title":"Asset Type","description":"Type of asset (e.g., Interests, Dividends)"},"gross_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Gross capital income"},"tax_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Tax withheld from capital income"},"penalization":{"$ref":"#/components/schemas/CurrencyAmount","description":"Penalization for early withdrawal"},"deductible_expenses":{"$ref":"#/components/schemas/CurrencyAmount","description":"Deductible administration or custody fees"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["asset_type","gross_income","tax_withheld","penalization","deductible_expenses","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Capital Income Line"},"CardTransactionSchema":{"properties":{"type":{"type":"string","enum":["unknown","opening","closure","credit","debit","default"],"title":"FinancialTransactionType","description":"Transaction type"},"status":{"type":"string","enum":["unknown","pending","booked","cancelled","failed","reversed"],"title":"FinancialTransactionStatus","description":"Transaction status"},"value_date":{"type":"string","format":"date","title":"Value Date","description":"Represents the moment when funds were set aside for a specific transaction, ensuring their readiness for eventual processing. From a banking perspective, this might appear as a temporary allocation or pre-authorization related to the purchase."},"amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Transaction amount"},"descriptions":{"items":{"type":"string"},"type":"array","title":"Descriptions","description":"Original transaction descriptions"},"provider_id":{"type":"string","title":"Provider Id","description":"Unique ID for the transaction in the provider system"},"merchant":{"$ref":"#/components/schemas/EntitySchema","description":"Merchant information, if available"}},"type":"object","required":["type","status"],"title":"Financial Account Transaction"},"ClabeIdentifierSchema":{"properties":{"type":{"type":"string","const":"clabe","title":"Type"},"value":{"type":"string","format":"CLABE","title":"Value","description":"Clave Bancaria Estandarizada","examples":["014027000005555558"]},"masked":{"type":"string","maxLength":19,"minLength":1,"title":"Masked","description":"Partial Clabe"},"entity_country":{"type":"string","title":"Entity Country","description":"Bank Country","readOnly":true},"entity_code":{"type":"string","title":"Entity Code","description":"Bank code","readOnly":true},"entity_office":{"type":"string","title":"Entity Office","description":"Bank office","readOnly":true},"control_digits":{"type":"string","title":"Control Digits","description":"Control digit","readOnly":true}},"type":"object","required":["type","value","masked","entity_country","entity_code","entity_office","control_digits"],"title":"CLABE","description":"Clave Bancaria Estandarizada"},"ClientAppHooksConfigSchema":{"properties":{"app_id":{"type":"string","format":"ObjectId","title":"App Id","description":"App ID","examples":["644599da47847b79c03cc94f"]},"producer":{"anyOf":[{"type":"string","const":"Root","title":"Root"},{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"}],"title":"Producer","description":"Use `Root` to suscribe to events produced by general execution, such as the beginning and the end of the execution. *You can also use a `FeatureType` to subscribe to events produced by an specific feature*"},"event":{"type":"string","enum":["started","action_required","ended","auth_ended"],"title":"ExecutionEventType","description":"Event to trigger the hook"},"enabled":{"type":"boolean","title":"Enabled","description":"Indicates if the hook is enabled"},"method":{"type":"string","enum":["POST","PUT"],"title":"CallbackHttpMethod","description":"HTTP method to use"},"base_url":{"type":"string","title":"Base Url","description":"Base URL to send the request to. Dynamic query parameters can be added later."}},"type":"object","required":["app_id","producer","event","enabled","method","base_url"],"title":"Client App Hook Config","description":"Configuration indicating which hooks are enabled for an app and what callback to use for each event"},"ClientAppSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","examples":["644599da47847b79c03cc94f"]},"company_id":{"type":"string","format":"ObjectId","title":"Company Id","examples":["644599da47847b79c03cc94f"]},"display_name":{"type":"string","maxLength":50,"minLength":1,"title":"Display Name","description":"Public name"},"internal_name":{"type":"string","maxLength":50,"minLength":1,"title":"Internal Name","description":"Internal Name"},"environment":{"$ref":"#/components/schemas/AppEnvironment"},"approved_at":{"anyOf":[{"type":"null","title":"null","description":"No value. Allowed value: `null`"},{"type":"string","format":"datetime","examples":["2023-10-05T14:46:36.546596Z"]}],"title":"Approved At"},"description":{"anyOf":[{"type":"null","title":"null","description":"No value. Allowed value: `null`"},{"type":"string","maxLength":250,"minLength":1}],"title":"Description"},"website":{"anyOf":[{"type":"null","title":"null","description":"No value. Allowed value: `null`"},{"$ref":"#/components/schemas/ToString_HttpUrl_"}],"title":"Website"},"contact_email":{"anyOf":[{"type":"null","title":"null","description":"No value. Allowed value: `null`"},{"$ref":"#/components/schemas/ToString_EmailStr_"}],"title":"Contact Email"},"deleted_at":{"anyOf":[{"type":"null","title":"null","description":"No value. Allowed value: `null`"},{"type":"string","format":"datetime","examples":["2023-10-05T14:46:36.546596Z"]}],"title":"Deleted At"},"tags":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Tags","description":"User Tags","examples":["['Some Tag', 'Another Tag']"]},"lockable":{"$ref":"#/components/schemas/LockableSchema"},"is_locked":{"type":"boolean","title":"Is Locked","description":"Indicates if the app is locked","readOnly":true},"status":{"$ref":"#/components/schemas/AppStatus","description":"Application status","readOnly":true}},"type":"object","required":["id","company_id","display_name","internal_name","environment","tags","lockable","is_locked","status"],"title":"Client / App"},"ClientInvoiceSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Invoice ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"client_invoice","title":"Product"},"sub_family":{"type":"string","enum":["client_invoice:receipt","client_invoice:standard","client_invoice:proforma","client_invoice:credit_memo","client_invoice:debit_memo","client_invoice:electronic","client_invoice:retail","client_invoice:comercial"],"title":"ClientInvoiceType","description":"Client Invoice Type\nAllowed values are:\n - `client_invoice:receipt`: Receipt or Simplified Invoice\n- `client_invoice:standard`: Standard Invoice\n- `client_invoice:proforma`: Proforma Invoice\n- `client_invoice:credit_memo`: Credit Memo\n- `client_invoice:debit_memo`: Debit Memo\n- `client_invoice:electronic`: Electronic Invoice\n- `client_invoice:retail`: Retail Invoice\n- `client_invoice:comercial`: Comercial Invoice"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"type":"string","title":"Identifier","description":"Invoice number"},"contract":{"type":"string","title":"Contract","description":"Contract if any"},"issue_date":{"type":"string","format":"datetime","title":"Issue Date","description":"Issue date","examples":["2023-10-05T14:46:36.546596Z"]},"due_date":{"type":"string","format":"datetime","title":"Due Date","description":"Due date","examples":["2023-10-05T14:46:36.546596Z"]},"tax_details":{"items":{"$ref":"#/components/schemas/TaxDetailSchema"},"type":"array","title":"Tax Details","description":"Tax details"},"total_tax_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total tax amount"},"total_discount_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total discount amount"},"total_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total amount"},"total_net_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total net amount"},"issuer":{"$ref":"#/components/schemas/EntityDto","description":"Issuer"},"receiver":{"$ref":"#/components/schemas/EntityDto","description":"Receiver"},"attachments":{"items":{"$ref":"#/components/schemas/FileAttachmentSchema"},"type":"array","title":"Attachments","description":"List of attached supporting documents","default":[]}},"type":"object","required":["id","product","sub_family","fetch_date"],"title":"Client Invoice"},"CloudResourceSchema":{"properties":{"product":{"type":"string","const":"cloud_product","title":"Product"},"sub_family":{"type":"string","const":"cloud_product:resource","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"provider":{"type":"string","enum":["aws","azure","gcp","ibm","oracle","alibaba","salesforce","vmware","redhat","sap","rackspace","digitalocean","unspecified"],"title":"CloudProvider","description":"Provider"},"region":{"type":"string","title":"Region","description":"Region Identifier"},"identifier":{"type":"string","title":"Identifier","description":"Resource Identifier"},"description":{"type":"string","title":"Description","description":"Resource description"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Resource metadata"}},"type":"object","required":["product","sub_family","fetch_date","provider","region","identifier","description","metadata"],"title":"Cloud Resource Schema"},"ConfigurationsFieldsGroupSchema":{"properties":{"$defs":{"additionalProperties":true,"type":"object","title":"$Defs","description":"Definitions"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Properties of the form"},"required":{"items":{"type":"string"},"type":"array","title":"Required","description":"List of required fields"},"type":{"type":"string","const":"object","title":"Type","description":"Type of the form"},"format":{"type":"string","const":"cg-configs","title":"Format","description":"Type of form"},"x-meta":{"$ref":"#/components/schemas/catgrid_core__schemas__ui__field_group__FieldsGroupSchema__XMeta","description":"Meta information of the form"}},"additionalProperties":true,"type":"object","required":["properties","type","format"],"title":"Configurations Fields Group","description":"Description of the configuration form in OpenAPI 3.0.3 Schema Object, all OpenAPI 3.0.3 Schema Object properties are\nallowed, we detail the ones that are required for the configuration form in this model."},"ContributionBaseSchema":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Date of the contribution"},"concept":{"type":"string","title":"Concept","description":"Company or Regime"},"base":{"anyOf":[{"type":"string","const":"pending"},{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1"}],"title":"Base","description":"Amount of the contribution"}},"type":"object","required":["date","concept","base"],"title":"Monthly Contribution Base"},"CreditCardSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_card","title":"Product"},"sub_family":{"type":"string","const":"financial_card:credit","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"$ref":"#/components/schemas/PanIdentifierSchema","description":"PAN"},"entity_country":{"type":"string","format":"country","title":"Entity Country","description":"Entity country","examples":["ES","US"]},"entity_code":{"type":"string","title":"Entity Code","description":"Entity code"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"holder_name":{"type":"string","title":"Holder Name","description":"Card holder name"},"status":{"type":"string","enum":["unknown","active","cancelled","blocked"],"title":"FinancialCardStatus","description":"Financial Card Status\nAllowed values are:\n - `unknown`: Unknown\n- `active`: Active\n- `cancelled`: Cancelled\n- `blocked`: Blocked"},"expiration_date":{"type":"string","format":"date","title":"Expiration Date","description":"Card expiration date"},"linked_account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Linked account, if proceeds"},"available":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The current amount of credit that a user has access to, based on their credit limit minus any current outstanding balances or pending transactions. It indicates the remaining amount the user can still borrow or use."},"disposed":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The current amount of credit that a user has used or withdrawn."},"limit":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The maximum amount of credit that a financial institution extends to a client through a line of credit. This represents the maximum amount of credit that a user can use or withdraw."},"payment_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The smallest amount that must be paid by a specified due date to keep the account in good standing and avoid potential penalties or additional interest charges. This amount generally covers the accrued interest and may include a portion of the principal balance. Paying only this amount by the due date may result in carrying a balance to the next billing cycle, which could incur interest."},"next_payment_date":{"type":"string","format":"date","title":"Next Payment Date","description":"Next Payment Date"},"billing_period_start":{"type":"string","format":"date","title":"Billing Period Start","description":"Period Start Date"},"billing_period_end":{"type":"string","format":"date","title":"Billing Period End","description":"Period End Date"},"transactions":{"items":{"$ref":"#/components/schemas/CardTransactionSchema"},"type":"array","title":"Transactions","description":"Card transactions"}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name","status"],"title":"Credit Card"},"CurrencyAmount":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}]},"CurrencyAmountSchema":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***","title":"***","description":"Unknown currency","examples":["***"]}],"title":"Currency"},"amount":{"type":"string","format":"number","title":"Amount","description":"Decimal number with 6 digits precision","default":"nan","examples":["1.000000","NaN"]}},"type":"object","required":["currency"],"title":"Currency Amount"},"CurrentAccountSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_account","title":"Product"},"sub_family":{"type":"string","const":"financial_account:current","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"data_enrichment":{"type":"string","enum":["skipped","pending","processing","ready","failed"],"title":"DataEnrichmentStatus","description":"Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data."},"identifier":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Identifier","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"opening_date":{"type":"string","format":"date","title":"Opening Date","description":"Account opening date"},"available":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The total accessible funds, considering all cleared and uncleared transactions. This represents the amount a user can use or withdraw immediately.","deprecated":true},"booked":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The net monetary amount without considering pending transactions. It reflects the actual balance at any given moment.","deprecated":true},"transactions":{"items":{"$ref":"#/components/schemas/AccountTransactionSchema"},"type":"array","title":"Transactions","description":"Account transactions"},"holders":{"items":{"$ref":"#/components/schemas/AccountHolderSchema"},"type":"array","title":"Holders","description":"Account holders"}},"type":"object","required":["id","product","sub_family","fetch_date","data_enrichment","identifier","customer_segment","product_name"],"title":"Current Account"},"CustomerFamily":{"properties":{"profile":{"$ref":"#/components/schemas/CustomerProfileSchema","description":"Customer profile"}},"type":"object","title":"Customer Family"},"CustomerProfileSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Customer ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"customer_information","title":"Product"},"sub_family":{"type":"string","const":"customer_information:user_profile","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identification_numbers":{"items":{"$ref":"#/components/schemas/IdentificationNumberSchema"},"type":"array","title":"Identification Numbers","description":"Identification numbers of the customer"},"name":{"type":"string","title":"Name","description":"Name"},"name_extra":{"type":"string","title":"Name Extra","description":"Extra name"},"alias":{"type":"string","title":"Alias","description":"Alias"},"birth_date":{"type":"string","format":"date","title":"Birth Date","description":"Birth date"},"birth_country":{"type":"string","format":"country","title":"Birth Country","description":"Country of birth","examples":["ES","US"]},"nationality_country":{"type":"string","format":"country","title":"Nationality Country","description":"Country of nationality","examples":["ES","US"]},"residence_country":{"type":"string","format":"country","title":"Residence Country","description":"Country of residence","examples":["ES","US"]},"language":{"type":"string","format":"language","title":"Language <ISO 639-2>","description":"Main language","examples":["eng","spa"]},"type":{"type":"string","enum":["person","company","unknown"],"title":"CustomerType","description":"Customer type"},"gender":{"type":"string","enum":["male","female","rather_not_say","unknown"],"title":"PersonGender","description":"Person gender"},"civil_status":{"type":"string","enum":["single","married","divorced","widowed","separated","unknown"],"title":"CivilStatus","description":"Civil status"},"emails":{"items":{"type":"string"},"type":"array","title":"Emails","description":"Customer Emails"},"phones":{"items":{"type":"string"},"type":"array","title":"Phones","description":"Customer Phones"},"addresses":{"items":{"$ref":"#/components/schemas/AddressSchema"},"type":"array","title":"Addresses","description":"Customer Addresses"},"member_since":{"type":"string","format":"date","title":"Member Since","description":"Membership start date"},"number_of_children":{"type":"integer","title":"Number Of Children","description":"Number of children"}},"type":"object","required":["id","product","sub_family","fetch_date","identification_numbers","type","gender","civil_status","emails","phones","addresses"],"title":"Customer Profile"},"DebitCardSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_card","title":"Product"},"sub_family":{"type":"string","const":"financial_card:debit","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"$ref":"#/components/schemas/PanIdentifierSchema","description":"PAN"},"entity_country":{"type":"string","format":"country","title":"Entity Country","description":"Entity country","examples":["ES","US"]},"entity_code":{"type":"string","title":"Entity Code","description":"Entity code"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"holder_name":{"type":"string","title":"Holder Name","description":"Card holder name"},"status":{"type":"string","enum":["unknown","active","cancelled","blocked"],"title":"FinancialCardStatus","description":"Financial Card Status\nAllowed values are:\n - `unknown`: Unknown\n- `active`: Active\n- `cancelled`: Cancelled\n- `blocked`: Blocked"},"expiration_date":{"type":"string","format":"date","title":"Expiration Date","description":"Card expiration date"},"linked_account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Linked account, if proceeds"},"transactions":{"items":{"$ref":"#/components/schemas/CardTransactionSchema"},"type":"array","title":"Transactions","description":"Card transactions"}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name","status"],"title":"Debit Card"},"DeductionDetails":{"properties":{"donations":{"items":{"$ref":"#/components/schemas/DonationLine"},"type":"array","title":"Donations","description":"List of donations"},"total_donations":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total donations"},"personal_allowance":{"$ref":"#/components/schemas/CurrencyAmount","description":"Personal tax-free allowance"},"family_allowance":{"$ref":"#/components/schemas/CurrencyAmount","description":"Family tax-free allowances (children, ascendants)"},"regional_deductions":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total deductions applied at regional level"},"state_deductions":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total deductions applied at state level"},"total_deductions":{"$ref":"#/components/schemas/CurrencyAmount","description":"Grand total of all deductions"}},"type":"object","required":["donations","total_donations","personal_allowance","family_allowance","regional_deductions","state_deductions","total_deductions"],"title":"Yearly Fiscal Data / Persons / Deduction Details"},"Delete":{"properties":{"event":{"type":"string","enum":["started","action_required","ended","auth_ended"],"title":"ExecutionEventType","description":"Event to match the deletion"},"producer":{"anyOf":[{"type":"string","const":"Root","title":"Root"},{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"}],"title":"Producer","description":"Producer to match the deletion"}},"additionalProperties":false,"type":"object","required":["event","producer"],"title":"Delete Client App Hook Config"},"DictValuesToList_FeatureStateSchema_":{"items":{"$ref":"#/components/schemas/FeatureStateSchema"},"type":"array"},"DirectDebitTransactionSchema":{"properties":{"status":{"type":"string","enum":["unknown","pending","booked","cancelled","failed","reversed"],"title":"FinancialTransactionStatus","description":"Transaction status"},"issue_date":{"type":"string","format":"datetime","title":"Issue Date","description":"Transaction issue date","examples":["2023-10-05T14:46:36.546596Z"]},"payment_date":{"type":"string","format":"datetime","title":"Payment Date","description":"Transaction payment date","examples":["2023-10-05T14:46:36.546596Z"]},"concept":{"type":"string","title":"Concept","description":"Transaction concept"},"amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Transaction amount"}},"type":"object","required":["status"],"title":"Direct Debit Transaction"},"DonationLine":{"properties":{"entity_id":{"type":"string","title":"Entity Id","description":"Identifier of the receiving entity (NIF/CIF)"},"entity_name":{"type":"string","title":"Entity Name","description":"Name of the receiving entity"},"donation_type":{"type":"string","title":"Donation Type","description":"Type of donation (e.g., Donativo)"},"amount":{"$ref":"#/components/schemas/CurrencyAmount","description":"Amount donated"},"is_recurring":{"type":"boolean","title":"Is Recurring","description":"Whether the donation is recurring"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["entity_id","entity_name","amount","is_recurring","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Donation Line"},"DrivingLicenseSchema":{"properties":{"category":{"type":"string","title":"Category","description":"Class of driving license."},"date":{"type":"string","format":"date","title":"Date","description":"Granted date."},"expires":{"type":"string","format":"date","title":"Expires","description":"Expiry date."}},"type":"object","required":["category","date"],"title":"Driving License"},"ESOwnedPropertySchema":{"properties":{"product":{"type":"string","const":"owned_property","title":"Product"},"sub_family":{"type":"string","const":"owned_property:es_owned_property","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country","description":"Country of the property.","examples":["ES","US"]},"cadastral_reference":{"type":"string","title":"Cadastral Reference","description":"Unique cadastral reference identifier."},"address":{"type":"string","title":"Address","description":"Full address of the property."},"property_type":{"type":"string","title":"Property Type","description":"Type of property (e.g., Urban, Rustic)."},"property_use":{"type":"string","title":"Property Use","description":"Main use of the property (e.g., Residential)."},"assessment_year":{"type":"string","title":"Assessment Year","description":"Year of the catastral assessment."},"assessed_value":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total assessed cadastral value."},"land_value":{"$ref":"#/components/schemas/CurrencyAmount","description":"Assessed land value."},"construction_value":{"$ref":"#/components/schemas/CurrencyAmount","description":"Assessed construction value."},"owners":{"items":{"$ref":"#/components/schemas/PropertyOwnerSchema"},"type":"array","title":"Owners","description":"List of owners of the property."},"cartography_link":{"type":"string","title":"Cartography Link","description":"Link to the cartography map."},"download_info":{"$ref":"#/components/schemas/CadastralDownloadInfoSchema","description":"Internal metadata for downloading documents."}},"type":"object","required":["product","sub_family","fetch_date","country","owners"],"title":"Spain - Owned Property"},"EUDriverDataSchema":{"properties":{"product":{"type":"string","const":"driver_data","title":"Product"},"sub_family":{"type":"string","const":"driver_data:eu_driver_data","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country","description":"Country that expired the license.","examples":["ES","US"]},"licences":{"items":{"$ref":"#/components/schemas/DrivingLicenseSchema"},"type":"array","title":"Licences","description":"List of driving licenses."},"point_balance":{"type":"integer","maximum":20.0,"minimum":0.0,"title":"Point Balance","description":"Balance of the driver in points."},"name":{"type":"string","title":"Name","description":"First name of the driver"},"name_extra":{"type":"string","title":"Name Extra","description":"Last name of the driver."},"identifier":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"NIF of the driver."},"dangerous_goods_authorized":{"type":"boolean","title":"Dangerous Goods Authorized","description":"Whether the driver is authorized to transport dangerous goods."},"school_transport_authorized":{"type":"boolean","title":"School Transport Authorized","description":"Whether the driver is authorized to transport school goods."},"address":{"type":"string","title":"Address","description":"Address of the driver."},"point_movements":{"items":{"$ref":"#/components/schemas/PointMovementSchema"},"type":"array","title":"Point Movements","description":"List of movements."}},"type":"object","required":["product","sub_family","fetch_date","country","licences","point_balance","dangerous_goods_authorized","school_transport_authorized","point_movements"],"title":"EU - Driver Data"},"EUOwnedVehicleSchema":{"properties":{"product":{"type":"string","const":"driver_data","title":"Product"},"sub_family":{"type":"string","const":"driver_data:eu_owned_vehicle","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country","description":"Country where the vehicle is registered.","examples":["ES","US"]},"registration_date":{"type":"string","format":"date","title":"Registration Date","description":"Registration date of the vehicle."},"inspection_expiry_date":{"type":"string","format":"date","title":"Inspection Expiry Date","description":"Expiry date of the vehicle inspection."},"license_plate":{"type":"string","title":"License Plate","description":"License plate number of the vehicle."},"vin":{"type":"string","title":"Vin","description":"Vehicle Identification Number."},"make":{"type":"string","title":"Make","description":"Vehicle manufacturer."},"model":{"type":"string","title":"Model","description":"Vehicle model name."},"trim":{"type":"string","title":"Trim","description":"Specific vehicle trim/variant."},"color":{"type":"string","title":"Color","description":"Color of the vehicle."},"mileage":{"type":"integer","minimum":0.0,"title":"Mileage","description":"Last reported mileage in Km."},"mileage_date":{"type":"string","format":"date","title":"Mileage Date","description":"Date when the mileage was recorded."},"fuel_type":{"type":"string","title":"Fuel Type","description":"Fuel type of the vehicle."},"emission_class":{"type":"string","title":"Emission Class","description":"Emission class of the vehicle."},"insurance":{"$ref":"#/components/schemas/VehicleInsuranceSchema","description":"Vehicle insurance policy."}},"type":"object","required":["product","sub_family","fetch_date","country","registration_date","inspection_expiry_date"],"title":"EU - Owned Vehicle"},"EmploymentIncome":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/EmploymentIncomeLine"},"type":"array","title":"Lines","description":"List of employment income sources"},"total_gross":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total gross employment income"},"total_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total income tax withheld from employment"},"total_social_security":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total social security contributions"}},"type":"object","required":["lines","total_gross","total_withheld","total_social_security"],"title":"Yearly Fiscal Data / Persons / Employment Income"},"EmploymentIncomeLine":{"properties":{"employer_id":{"type":"string","title":"Employer Id","description":"Identifier of the employer (NIF/CIF)"},"employer_name":{"type":"string","title":"Employer Name","description":"Name of the employer"},"gross_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Gross income from this employer"},"tax_withheld":{"$ref":"#/components/schemas/CurrencyAmount","description":"Income tax withheld by this employer"},"social_security_contributions":{"$ref":"#/components/schemas/CurrencyAmount","description":"Social security contributions paid"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["employer_id","employer_name","gross_income","tax_withheld","social_security_contributions","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Employment Income Line"},"EngineExecutionSchema":{"properties":{"execution_id":{"type":"string","format":"ObjectId","title":"Execution Id","description":"Unique identifier for the execution identifier. This identifier can be used to fetch the status \nand results of the execution. Only available if the execution was accepted.","examples":["644599da47847b79c03cc94f"]},"session_id":{"type":"string","format":"ObjectId","title":"Session Id","description":"Unique identifier for the session. Only present for session controlled executions.","examples":["644599da47847b79c03cc94f"]},"app_id":{"type":"string","format":"ObjectId","title":"App Id","description":"Unique identifier for the app.","examples":["644599da47847b79c03cc94f"]},"customer_id":{"type":"string","title":"Customer Id","description":"External ID of the customer.  Refers to the customer and final owner of the credentials.<br/>\n_**Note:** This ID is relevant for statistics and reports._"},"auth_origin":{"$ref":"#/components/schemas/AuthOrigin"},"engine_reference":{"type":"string","format":"engine-reference","title":"Engine Reference","description":"Target engine to be executed.","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"external_execution_id":{"type":"string","title":"External Execution Id","description":"External ID of the execution. \nUnique identifier for the execution in the client system, used to tracking and also \nenables the use of the same `customer_id`/`engine_reference` for multiple simultaneous \nexecutions.<br/>\n_**Note:** If not provided, then you can only have one execution per \n`customer_id`/`engine_reference` at the same time._"},"status_reason":{"anyOf":[{"type":"string","enum":["ACCEPTED","WAITING","RUNNING"],"title":"OngoingReason","description":"Reasons for an ongoing status\nAllowed values are:\n - `ACCEPTED`: Execution has been accepted and is waiting to be processed\n- `WAITING`: The execution is warming up\n- `RUNNING`: The execution is running"},{"type":"string","enum":["PENDING_PARAMETERS","MFA_REQUIRED","INPUT_REQUIRED"],"title":"ActionRequiredReason","description":"Reasons for an action required status\nAllowed values are:\n - `PENDING_PARAMETERS`: The execution is waiting for user input of parameters\n- `MFA_REQUIRED`: The execution is waiting for user to solve a MFA challenge\n- `INPUT_REQUIRED`: The execution is waiting for dynamic input from the user"},{"type":"string","enum":["USER_CANCELLED","CLIENT_CANCELLED","SYSTEM_CANCELLED","TIMEOUT","ACTION_TIMEOUT","CUSTOMER_INTERVENTION_REQUIRED"],"title":"AbortedReason","description":"Reasons for an aborted status\nAllowed values are:\n - `USER_CANCELLED`: Cancelled by the user\n- `CLIENT_CANCELLED`: Cancelled by the client\n- `SYSTEM_CANCELLED`: Cancelled by System\n- `TIMEOUT`: The execution was cancelled due to a timeout\n- `ACTION_TIMEOUT`: Cancelled due to an action timeout\n- `CUSTOMER_INTERVENTION_REQUIRED`: Can not be processed without customer intervention"},{"type":"string","enum":["BAD_CONFIGURATIONS","BAD_PROXY_CONFIGURATION","ENCRYPTION_ERROR","INCORRECT_PARAMETERS_FORMAT","INCORRECT_RESUME_FORMAT","T10N_FORBIDDEN","T10N_REJECTED","T10N_NOT_AVAILABLE","T10N_EXCEPTION"],"title":"ConfigurationReason","description":"Reasons for a configuration error status\nAllowed values are:\n - `BAD_CONFIGURATIONS`: Rejected due to an invalid configuration\n- `BAD_PROXY_CONFIGURATION`: Rejected due to an invalid proxy configuration\n- `ENCRYPTION_ERROR`: Rejected due to an encryption error\n- `INCORRECT_PARAMETERS_FORMAT`: Rejected due to invalid resume payload\n- `INCORRECT_RESUME_FORMAT`: Rejected due to invalid resume payload\n- `T10N_FORBIDDEN`: Current application is not allowed to use tokenization\n- `T10N_REJECTED`: Token is locked or has been revoked\n- `T10N_NOT_AVAILABLE`: Tokenization is not available for this engine\n- `T10N_EXCEPTION`: Unexpected exception during tokenization"},{"type":"string","enum":["COMPLETED"],"title":"CompletedReason","description":"Reasons for a completed status\nAllowed values are:\n - `COMPLETED`: Completed successfully"},{"type":"string","enum":["PARTIAL"],"title":"PartialReason","description":"Reasons for a partial status\nAllowed values are:\n - `PARTIAL`: Completed with errors"},{"type":"string","enum":["FAILED"],"title":"FailedReason","description":"Reasons for a failed status\nAllowed values are:\n - `FAILED`: Failed to complete the execution"},{"type":"string","enum":["AUTH_OK","INCORRECT_CREDENTIALS","INCORRECT_MFA","DUPLICATED_SESSION","FRIEZED_CREDENTIALS","BLOCKED_USER","MANUAL_INTERVENTION","CHANGE_PASSWORD","INCOMPATIBLE_ACCESS"],"title":"AuthenticationReason","description":"Reasons for an authentication error status\nAllowed values are:\n - `AUTH_OK`: Authenticated successfully\n- `INCORRECT_CREDENTIALS`: Authentication failed due to incorrect credentials\n- `INCORRECT_MFA`: Authentication failed due to incorrect MFA\n- `DUPLICATED_SESSION`: Authentication failed due to duplicated session\n- `FRIEZED_CREDENTIALS`: Authentication failed due to temporally locked credentials\n- `BLOCKED_USER`: Authentication failed due to blocked user\n- `MANUAL_INTERVENTION`: The source requests manual intervention to continue\n- `CHANGE_PASSWORD`: Authentication failed due to password change required\n- `INCOMPATIBLE_ACCESS`: Authentication failed due to incompatible access"},{"type":"string","enum":["UNHANDLED_AUTH_ERROR"],"title":"UnhandledAuthReason","description":"Reasons for an unhandled authentication error status\nAllowed values are:\n - `UNHANDLED_AUTH_ERROR`: Unhandled authentication error"},{"type":"string","enum":["ENGINE_UNAVAILABLE","ENGINE_BANNED","OUT_OF_SERVICE","ALREADY_EXECUTING","AUTO_CAPTCHA_ERROR","PROXY_ERROR","NETWORK_ERROR","INTERNAL_ERROR"],"title":"TemporaryReason","description":"Reasons for a temporary error status\nAllowed values are:\n - `ENGINE_UNAVAILABLE`: Engine is temporarily unavailable\n- `ENGINE_BANNED`: Source banned the engine\n- `OUT_OF_SERVICE`: The execution cannot be processed due to source unavailability\n- `ALREADY_EXECUTING`: Engine is already executing\n- `AUTO_CAPTCHA_ERROR`: Engine warmup failed due to captcha error\n- `PROXY_ERROR`: Engine warmup failed due to proxy error\n- `NETWORK_ERROR`: Engine warmup failed due to network error\n- `INTERNAL_ERROR`: Engine warmup failed due to internal error"}],"title":"Status Reason","description":"Execution status reason"},"status_message":{"type":"string","title":"Status Message","description":"Optional user message for the execution status."},"detail":{"items":{"$ref":"#/components/schemas/ErrorDetails"},"type":"array","title":"Detail"},"ticket":{"type":"string","maxLength":64,"minLength":64,"title":"Ticket","description":"Tokenization ticket to be exchanged for a tokenization key if Tokenized Access is being used."},"status_code":{"type":"string","enum":["ONGOING","ACTION_REQUIRED","COMPLETED","ABORTED","CONFIGURATION_ERROR","PARTIAL","TEMPORARY_ERROR","AUTH_ERROR","UNHANDLED_AUTH_ERROR","FAILED"],"title":"StatusCode","description":"Execution status code","readOnly":true}},"type":"object","required":["app_id","customer_id","auth_origin","engine_reference","status_reason","status_code"],"title":"Execution Acceptance Response","description":"Response schema for direct execution requests indicates the initial status of the execution request\nand the `execution_id` that can be used to query the status and results of the execution."},"EngineFeatureDetailsSchema":{"properties":{"code":{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"},"events":{"items":{"type":"string","enum":["started","action_required","ended","auth_ended"],"title":"ExecutionEventType","description":"The type of event that is being reported\nAllowed values are:\n - `started`: Execution has started\n- `action_required`: Execution requires an action (Ex: MFA)\n- `ended`: Execution has ended\n- `auth_ended`: Authentication has ended"},"type":"array","title":"Events","description":"Possible Events raised by the current feature. You can subscribe to the desired events to receive notifications and status updates about the execution of the feature.\nAllowed values are:\n - `started`: Execution has started\n- `action_required`: Execution requires an action (Ex: MFA)\n- `ended`: Execution has ended\n- `auth_ended`: Authentication has ended"},"configurations":{"$ref":"#/components/schemas/ConfigurationsFieldsGroupSchema","description":"Description of the feature configurations in OpenAPI 3.0.3 Schema Object format"}},"type":"object","required":["code","configurations"],"title":"Engine Feature Details","description":"Detailed information of a feature, this information is used to describe the feature configurations"},"EntityDto":{"properties":{"name":{"type":"string","title":"Name","description":"Entity name"},"tax_id":{"type":"string","title":"Tax Id","description":"Entity Tax ID"},"address":{"type":"string","title":"Address","description":"Entity address"}},"type":"object","title":"Entity"},"EntitySchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name"},"code":{"type":"string","title":"Code","description":"Code"},"country_code":{"type":"string","format":"country","title":"Country Code","description":"Country Code","examples":["ES","US"]},"identifier":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"Holder identifier"}},"type":"object","title":"Entity"},"ErrorDetails":{"properties":{"type":{"type":"string","title":"Type","description":"The type of error that occurred, this is an identifier designed for\nprogrammatic use that will change rarely or never.\n\n`type` is unique for each error message, and can hence be used as an identifier to build custom error messages."},"loc":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array","title":"Loc","description":"Tuple of strings and ints identifying where in the schema the error occurred."},"msg":{"type":"string","title":"Msg","description":"A human readable error message."},"input":{"title":"Input","description":"The input data at this `loc` that caused the error."},"ctx":{"additionalProperties":true,"type":"object","title":"Ctx","description":"Values which are required to render the error message, and could hence be useful in rendering custom error messages.\nAlso useful for passing custom error data forward."},"url":{"type":"string","title":"Url","description":"The documentation URL giving information about the error. No URL is available if\na [`PydanticCustomError`][pydantic_core.PydanticCustomError] is used."}},"type":"object","required":["type","loc","msg","input"],"title":"ErrorDetails"},"ErrorResponse":{"properties":{"detail":{"type":"string","title":"Detail","description":"Error message","examples":["Some error message"]}},"type":"object","required":["detail"],"title":"Error Response","description":"Error response details"},"EstimationMeta":{"properties":{"estimation_date":{"type":"string","format":"datetime","title":"Estimation Date","description":"Date when the estimation was made","examples":["2023-10-05T14:46:36.546596Z"]},"status":{"type":"string","enum":["success","not_currently_active_in_ss","no_active_relations"],"title":"Status","description":"The final status of the estimation"},"mode":{"type":"string","const":"global_irpf","title":"Mode","description":"The estimation mode used"},"recent_window":{"type":"integer","title":"Recent Window","description":"Number of months in the recent projection window"},"full_window":{"type":"integer","title":"Full Window","description":"Number of months in the full projection window"},"global_rate":{"type":"string","format":"number","title":"Global Rate","description":"The combined IRPF rate applied","default":"nan","examples":["1.000000","NaN"]}},"type":"object","required":["estimation_date","status"],"title":"EstimationMeta"},"Exchange":{"properties":{"token":{"$ref":"#/components/schemas/TokenCredentialSchema","description":"Credentials token containing the token ID and key."},"context":{"$ref":"#/components/schemas/TokenCredentialContextSchema","description":"Credentials context."}},"type":"object","required":["token","context"],"title":"Token Credentials Exchange Response","description":"Response schema for token credentials acceptance containing both the token and its context.\nThe response includes:\n- A credential token containing the token ID and key\n- The context object with engine reference, app ID, customer ID, parameter ID, and features"},"ExchangeTokenRequest":{"properties":{"execution_id":{"type":"string","format":"ObjectId","title":"Execution Id","description":"Execution that originated the ticket.","examples":["644599da47847b79c03cc94f"]},"ticket":{"type":"string","maxLength":64,"minLength":64,"title":"Ticket","description":"Ticket obtained during the execution init."}},"additionalProperties":false,"type":"object","required":["execution_id","ticket"],"title":"Exchange Token Request","description":"Using the provided ticket and the execution ID of the request used to authenticate,\nthis endpoint returns a token that can be used to authenticate without requiring\nto store the credentials in your side"},"Execute":{"properties":{"external_execution_id":{"type":"string","maxLength":64,"minLength":1,"title":"External Execution Id","description":"External ID of the execution. \nUnique identifier for the execution in the client system, used to tracking and also \nenables the use of the same `customer_id`/`engine_reference` for multiple simultaneous \nexecutions.<br/>\n_**Note:** If not provided, then you can only have one execution per \n`customer_id`/`engine_reference` at the same time._"},"base_configurations":{"$ref":"#/components/schemas/BaseEngineConfigurationsSchema"},"features":{"items":{"oneOf":[{"$ref":"#/components/schemas/FeatureCustomerInformationReadRequest"},{"$ref":"#/components/schemas/FeatureContractsReadRequest"},{"$ref":"#/components/schemas/FeatureBankAccountsReadRequest"},{"$ref":"#/components/schemas/FeatureCreditsReadRequest"},{"$ref":"#/components/schemas/FeatureBankCardsReadRequest"},{"$ref":"#/components/schemas/FeatureBankDepositsReadRequest"},{"$ref":"#/components/schemas/FeatureBankLoansReadReadRequest"},{"$ref":"#/components/schemas/FeatureInvestmentAccountsReadRequest"},{"$ref":"#/components/schemas/FeatureBankFundsReadRequest"},{"$ref":"#/components/schemas/FeatureBankStocksReadRequest"},{"$ref":"#/components/schemas/FeaturePensionPlansReadRequest"},{"$ref":"#/components/schemas/FeatureDirectDebitsReadRequest"},{"$ref":"#/components/schemas/FeatureLaborCheckReadRequest"},{"$ref":"#/components/schemas/FeaturePublicPensionReadRequest"},{"$ref":"#/components/schemas/FeatureYearlyIndividualTaxRequest"},{"$ref":"#/components/schemas/FeatureVerifyPublicDocumentRequest"},{"$ref":"#/components/schemas/FeatureCitizenDataReadRequest"},{"$ref":"#/components/schemas/FeatureDriverDataReadRequest"},{"$ref":"#/components/schemas/FeaturePropertiesDataReadRequest"},{"$ref":"#/components/schemas/FeatureAcademicDataReadRequest"},{"$ref":"#/components/schemas/FeatureSupplierInvoicesReadRequest"},{"$ref":"#/components/schemas/FeatureClientInvoicesReadRequest"}],"discriminator":{"propertyName":"code","mapping":{"academic_data":"#/components/schemas/FeatureAcademicDataReadRequest","accounts_read":"#/components/schemas/FeatureBankAccountsReadRequest","cards_read":"#/components/schemas/FeatureBankCardsReadRequest","citizen_data":"#/components/schemas/FeatureCitizenDataReadRequest","client_invoices_read":"#/components/schemas/FeatureClientInvoicesReadRequest","credits_read":"#/components/schemas/FeatureCreditsReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","deposits_read":"#/components/schemas/FeatureBankDepositsReadRequest","direct_debits_read":"#/components/schemas/FeatureDirectDebitsReadRequest","driver_data":"#/components/schemas/FeatureDriverDataReadRequest","funds_read":"#/components/schemas/FeatureBankFundsReadRequest","investment_accounts_read":"#/components/schemas/FeatureInvestmentAccountsReadRequest","labor_check":"#/components/schemas/FeatureLaborCheckReadRequest","loans_read":"#/components/schemas/FeatureBankLoansReadReadRequest","pensions_read":"#/components/schemas/FeaturePensionPlansReadRequest","properties_data":"#/components/schemas/FeaturePropertiesDataReadRequest","public_document_verification":"#/components/schemas/FeatureVerifyPublicDocumentRequest","public_pensions":"#/components/schemas/FeaturePublicPensionReadRequest","source_contracts_read":"#/components/schemas/FeatureContractsReadRequest","stocks_read":"#/components/schemas/FeatureBankStocksReadRequest","supplier_invoices_read":"#/components/schemas/FeatureSupplierInvoicesReadRequest","yearly_individual_tax":"#/components/schemas/FeatureYearlyIndividualTaxRequest"}}},"type":"array","title":"Features","description":"Features to be executed by the engine, with each feature containing its own configurations."},"configurations":{"additionalProperties":true,"type":"object","title":"Configurations","description":"Particular engine configurations for the target engine if any. These configurations can be found in the \ntarget engine specification.</br>\nExample: `{'use_case': 'normal_execution', 'expected_password': '12345678'}`"},"hooks_extra_data":{"$ref":"#/components/schemas/ExecutionHooksExtraDataType","default":{}},"engine_reference":{"type":"string","format":"engine-reference","title":"Engine Reference","description":"Target engine to be executed.","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"customer_id":{"type":"string","maxLength":64,"minLength":1,"title":"Customer Id","description":"External ID of the customer.  Refers to the customer and final owner of the credentials.<br/>\n_**Note:** This ID is relevant for statistics and reports._"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Particular engine parameters if any. These parameters can be found in the target engine specification. \nThe values can be optionally encrypted in the following format:<br/> \n- `rsa::<encrypted-payload_in-base64>` for RSA encryption.</br>\n\nExample: `{'username': 'john.doe', 'password': '12345678'}`"}},"additionalProperties":false,"type":"object","required":["engine_reference","customer_id","parameters"],"title":"Execution Request","description":"Payload for requesting a direct execution of an engine, use this method\nif you don't intend to use the INFONITE widget."},"ExecutionHooksExtraDataType":{"additionalProperties":{"type":"string"},"type":"object","description":"Extra data to be included in the execution hooks. This data will be returned in the webhook as part of the URL as query parameters. This can be useful to include dynamic data in the webhook.\nThere are some template variables that can be used in the URL:\n- `{app_id}`: Your app ID\n- `{customer_id}`: The customer ID\n- `{session_id}`: The Session ID\n- `{locking_hash}`: Credentials Hash, this identifier is computed by the engine based on the fixed part of the credentials  (e.g. the username)\n- `{producer}`: The producer of the event\n- `{event}`: The event that triggered the hook\n- `{status_code}`: The status of the flow at the moment of the event\nFor example, passing:\n```json\n{\n  \"custom_param\": \"customValue\",\n  \"current_event\": \"{event}\",\n  \"status\": \"{status_code}\",\n  \"id\": \"{session_id}\"\n}\n```\nWill result in the following URL:\n`https://your.url.com/your/path?custom_param=customValue&current_event=ended&status=COMPLETED&id=12345678&id=67d7d9b72eb0693e7da47a0e`_**Note:** This data is not encrypted and should not contain sensitive information._","examples":[{"current_event":"{event}","custom_param":"customValue","id":"{session_id}","status":"{session_id}"}]},"ExecutionStateSchema":{"properties":{"execution_id":{"type":"string","format":"ObjectId","title":"Execution Id","description":"Execution ID","examples":["644599da47847b79c03cc94f"]},"session_id":{"type":"string","format":"ObjectId","title":"Session Id","description":"Session ID","examples":["644599da47847b79c03cc94f"]},"app_id":{"type":"string","format":"ObjectId","title":"App Id","description":"App ID","examples":["644599da47847b79c03cc94f"]},"customer_id":{"type":"string","title":"Customer Id","description":"External customer ID"},"engine_reference":{"type":"string","format":"engine-reference","title":"Engine Reference","description":"Target engine","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"external_execution_id":{"type":"string","title":"External Execution Id","description":"External execution ID (if provided)"},"locking_hash":{"type":"string","title":"Locking Hash","description":"Deduplication hash for the part of the credentials that is fixed. For example, in an standard \nusername/password authentication, the username wil be used for building the hash, since the \npassword is a variable component. This field is useful for identifying unique credentials "},"auth_origin":{"$ref":"#/components/schemas/AuthOrigin"},"status_reason":{"anyOf":[{"type":"string","enum":["ACCEPTED","WAITING","RUNNING"],"title":"OngoingReason","description":"Reasons for an ongoing status\nAllowed values are:\n - `ACCEPTED`: Execution has been accepted and is waiting to be processed\n- `WAITING`: The execution is warming up\n- `RUNNING`: The execution is running"},{"type":"string","enum":["PENDING_PARAMETERS","MFA_REQUIRED","INPUT_REQUIRED"],"title":"ActionRequiredReason","description":"Reasons for an action required status\nAllowed values are:\n - `PENDING_PARAMETERS`: The execution is waiting for user input of parameters\n- `MFA_REQUIRED`: The execution is waiting for user to solve a MFA challenge\n- `INPUT_REQUIRED`: The execution is waiting for dynamic input from the user"},{"type":"string","enum":["USER_CANCELLED","CLIENT_CANCELLED","SYSTEM_CANCELLED","TIMEOUT","ACTION_TIMEOUT","CUSTOMER_INTERVENTION_REQUIRED"],"title":"AbortedReason","description":"Reasons for an aborted status\nAllowed values are:\n - `USER_CANCELLED`: Cancelled by the user\n- `CLIENT_CANCELLED`: Cancelled by the client\n- `SYSTEM_CANCELLED`: Cancelled by System\n- `TIMEOUT`: The execution was cancelled due to a timeout\n- `ACTION_TIMEOUT`: Cancelled due to an action timeout\n- `CUSTOMER_INTERVENTION_REQUIRED`: Can not be processed without customer intervention"},{"type":"string","enum":["BAD_CONFIGURATIONS","BAD_PROXY_CONFIGURATION","ENCRYPTION_ERROR","INCORRECT_PARAMETERS_FORMAT","INCORRECT_RESUME_FORMAT","T10N_FORBIDDEN","T10N_REJECTED","T10N_NOT_AVAILABLE","T10N_EXCEPTION"],"title":"ConfigurationReason","description":"Reasons for a configuration error status\nAllowed values are:\n - `BAD_CONFIGURATIONS`: Rejected due to an invalid configuration\n- `BAD_PROXY_CONFIGURATION`: Rejected due to an invalid proxy configuration\n- `ENCRYPTION_ERROR`: Rejected due to an encryption error\n- `INCORRECT_PARAMETERS_FORMAT`: Rejected due to invalid resume payload\n- `INCORRECT_RESUME_FORMAT`: Rejected due to invalid resume payload\n- `T10N_FORBIDDEN`: Current application is not allowed to use tokenization\n- `T10N_REJECTED`: Token is locked or has been revoked\n- `T10N_NOT_AVAILABLE`: Tokenization is not available for this engine\n- `T10N_EXCEPTION`: Unexpected exception during tokenization"},{"type":"string","enum":["COMPLETED"],"title":"CompletedReason","description":"Reasons for a completed status\nAllowed values are:\n - `COMPLETED`: Completed successfully"},{"type":"string","enum":["PARTIAL"],"title":"PartialReason","description":"Reasons for a partial status\nAllowed values are:\n - `PARTIAL`: Completed with errors"},{"type":"string","enum":["FAILED"],"title":"FailedReason","description":"Reasons for a failed status\nAllowed values are:\n - `FAILED`: Failed to complete the execution"},{"type":"string","enum":["AUTH_OK","INCORRECT_CREDENTIALS","INCORRECT_MFA","DUPLICATED_SESSION","FRIEZED_CREDENTIALS","BLOCKED_USER","MANUAL_INTERVENTION","CHANGE_PASSWORD","INCOMPATIBLE_ACCESS"],"title":"AuthenticationReason","description":"Reasons for an authentication error status\nAllowed values are:\n - `AUTH_OK`: Authenticated successfully\n- `INCORRECT_CREDENTIALS`: Authentication failed due to incorrect credentials\n- `INCORRECT_MFA`: Authentication failed due to incorrect MFA\n- `DUPLICATED_SESSION`: Authentication failed due to duplicated session\n- `FRIEZED_CREDENTIALS`: Authentication failed due to temporally locked credentials\n- `BLOCKED_USER`: Authentication failed due to blocked user\n- `MANUAL_INTERVENTION`: The source requests manual intervention to continue\n- `CHANGE_PASSWORD`: Authentication failed due to password change required\n- `INCOMPATIBLE_ACCESS`: Authentication failed due to incompatible access"},{"type":"string","enum":["UNHANDLED_AUTH_ERROR"],"title":"UnhandledAuthReason","description":"Reasons for an unhandled authentication error status\nAllowed values are:\n - `UNHANDLED_AUTH_ERROR`: Unhandled authentication error"},{"type":"string","enum":["ENGINE_UNAVAILABLE","ENGINE_BANNED","OUT_OF_SERVICE","ALREADY_EXECUTING","AUTO_CAPTCHA_ERROR","PROXY_ERROR","NETWORK_ERROR","INTERNAL_ERROR"],"title":"TemporaryReason","description":"Reasons for a temporary error status\nAllowed values are:\n - `ENGINE_UNAVAILABLE`: Engine is temporarily unavailable\n- `ENGINE_BANNED`: Source banned the engine\n- `OUT_OF_SERVICE`: The execution cannot be processed due to source unavailability\n- `ALREADY_EXECUTING`: Engine is already executing\n- `AUTO_CAPTCHA_ERROR`: Engine warmup failed due to captcha error\n- `PROXY_ERROR`: Engine warmup failed due to proxy error\n- `NETWORK_ERROR`: Engine warmup failed due to network error\n- `INTERNAL_ERROR`: Engine warmup failed due to internal error"}],"title":"Status Reason","description":""},"status_message":{"type":"string","title":"Status Message","description":""},"authentication_status":{"anyOf":[{"type":"string","const":"not-performed","title":"not-performed","description":"Authentication is not performed. Allowed value: `not-performed`"},{"type":"string","enum":["AUTH_OK","INCORRECT_CREDENTIALS","INCORRECT_MFA","DUPLICATED_SESSION","FRIEZED_CREDENTIALS","BLOCKED_USER","MANUAL_INTERVENTION","CHANGE_PASSWORD","INCOMPATIBLE_ACCESS"],"title":"AuthenticationReason","description":"Reasons for an authentication error status\nAllowed values are:\n - `AUTH_OK`: Authenticated successfully\n- `INCORRECT_CREDENTIALS`: Authentication failed due to incorrect credentials\n- `INCORRECT_MFA`: Authentication failed due to incorrect MFA\n- `DUPLICATED_SESSION`: Authentication failed due to duplicated session\n- `FRIEZED_CREDENTIALS`: Authentication failed due to temporally locked credentials\n- `BLOCKED_USER`: Authentication failed due to blocked user\n- `MANUAL_INTERVENTION`: The source requests manual intervention to continue\n- `CHANGE_PASSWORD`: Authentication failed due to password change required\n- `INCOMPATIBLE_ACCESS`: Authentication failed due to incompatible access"},{"type":"string","enum":["UNHANDLED_AUTH_ERROR"],"title":"UnhandledAuthReason","description":"Reasons for an unhandled authentication error status\nAllowed values are:\n - `UNHANDLED_AUTH_ERROR`: Unhandled authentication error"}],"title":"Authentication Status","description":"Authentication status"},"date_created":{"type":"string","format":"datetime","title":"Date Created","description":"Date when the execution was accepted","examples":["2023-10-05T14:46:36.546596Z"]},"date_started":{"type":"string","format":"datetime","title":"Date Started","description":"Date when the execution was started","examples":["2023-10-05T14:46:36.546596Z"]},"date_ended":{"type":"string","format":"datetime","title":"Date Ended","description":"Date when the execution ended","examples":["2023-10-05T14:46:36.546596Z"]},"running_time":{"type":"number","title":"Running Time","description":"Running time"},"total_elapsed_time":{"type":"number","title":"Total Elapsed Time","description":"Total elapsed time"},"features":{"$ref":"#/components/schemas/DictValuesToList_FeatureStateSchema_","description":"List of features states","default":[]},"configurations_errors":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Configurations Errors","description":"List of errors found during the validation of the configurations"},"parameters_errors":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Parameters Errors","description":"List of errors found during the validation of the parameters"},"products_count":{"additionalProperties":{"type":"integer"},"type":"object","title":"Products Count","description":"Counter by product, just for informational purposes"},"messages":{"items":{"$ref":"#/components/schemas/MessageSchema"},"type":"array","title":"Messages","description":"List of messages generated by the feature","default":[]},"is_closed":{"type":"boolean","title":"Is Closed","description":"Indicates if the execution is closed","readOnly":true},"status_code":{"type":"string","enum":["ONGOING","ACTION_REQUIRED","COMPLETED","ABORTED","CONFIGURATION_ERROR","PARTIAL","TEMPORARY_ERROR","AUTH_ERROR","UNHANDLED_AUTH_ERROR","FAILED"],"title":"StatusCode","description":"Execution status code","readOnly":true},"warnings_count":{"type":"integer","title":"Warnings Count","readOnly":true},"errors_count":{"type":"integer","title":"Errors Count","readOnly":true}},"type":"object","required":["execution_id","session_id","app_id","customer_id","engine_reference","auth_origin","status_reason","products_count","is_closed","status_code","warnings_count","errors_count"],"title":"Execution State"},"FeatureAcademicDataReadRequest":{"properties":{"code":{"type":"string","const":"academic_data","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__academic_data__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Academic Data","description":"Feature that retrieves the academic data from public administrations."},"FeatureBankAccountsReadRequest":{"properties":{"code":{"type":"string","const":"accounts_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__financial__accounts__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Financial Accounts Read","description":"Feature that retrieves bank account information.\n\nProvides access to:\n- Account balances and transactions\n- Account numbers and types\n- Account holders information"},"FeatureBankCardsReadRequest":{"properties":{"code":{"type":"string","const":"cards_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__financial__cards__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Financial Cards Read","description":"Feature that retrieves bank card information.\n\nProvides access to:\n- Debit and credit card details\n- Card status and validity\n- Card limits and restrictions\n- Transaction history\n- Associated accounts"},"FeatureBankDepositsReadRequest":{"properties":{"code":{"type":"string","const":"deposits_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Financial Deposits Read","description":"Feature that retrieves bank deposit information.\n\nProvides access to:\n- Fixed and term deposit details\n- Interest rates and terms\n- Maturity dates\n- Deposit amounts"},"FeatureBankFundsReadRequest":{"properties":{"code":{"type":"string","const":"funds_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Investment Funds Read","description":"Feature that retrieves mutual fund information.\n\nProvides access to:\n- Fund holdings and allocations\n- Fund performance metrics"},"FeatureBankLoansReadReadRequest":{"properties":{"code":{"type":"string","const":"loans_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Financial Loans Read","description":"Feature that retrieves bank loan information.\n\nProvides access to:\n- Loan balances and terms\n- Interest rates and fees\n- Loan type and status"},"FeatureBankStocksReadRequest":{"properties":{"code":{"type":"string","const":"stocks_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Investment Stocks Read","description":"Feature that retrieves stock investment information.\n\nProvides access to:\n- Stock holdings and positions\n- Market values and performance"},"FeatureCitizenDataReadRequest":{"properties":{"code":{"type":"string","const":"citizen_data","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__citizen_data__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Public Citizen Data","description":"Feature that retrieves the citizen data from public administrations aggregated folders."},"FeatureClientInvoicesReadRequest":{"properties":{"code":{"type":"string","const":"client_invoices_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/InvoicesReadConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Client Invoices Read","description":"Feature that retrieves public pension information from government services.\n\nFetches details about:\n- Retirement pensions and benefits \n- Widow/survivor pensions\n- Disability/incapacity benefits\n- Other government social assistance\n- Pension type, category and amounts"},"FeatureConfigurations":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","description":"The date from which the sub-product will be read","default":"30 days ago","examples":["2023-04-12"]},"to_date":{"type":"string","format":"date","title":"To Date","description":"The date until which the sub-product will be read","default":"today","examples":["2023-04-12"]},"limits_behaviour":{"type":"string","enum":["error","adapt"],"title":"Limits Behaviour","description":"The behaviour when the date limits are not respected.\n- `error`: raise an error and abort the execution\n- `adapt`: adapt the dates to the limits and continue the execution","default":"error"},"read_transactions":{"type":"boolean","title":"Read Transactions","description":"If true, the engine will try to read the credit transactions","default":false},"read_holders":{"type":"boolean","title":"Read Holders","description":"If true, the engine will try to read the credit holders","default":false}},"type":"object","title":"Credits Read Configurations"},"FeatureContractsReadRequest":{"properties":{"code":{"type":"string","const":"source_contracts_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Source Contracts Read","description":"Retrieves the contract information associated with the user from the connected source."},"FeatureCreditsReadRequest":{"properties":{"code":{"type":"string","const":"credits_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Financial Credits Read","description":"Feature that retrieves credit product information.\n\nProvides access to:\n- Credit balances and transactions\n- Credit line details\n- Credit line holders information\n- Interest rates and fees"},"FeatureCustomerInformationReadRequest":{"properties":{"code":{"type":"string","const":"customer_information_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Customer Information Read","description":"Extracts the profile information of the user from the connected source. \n\nFor example, in banking contexts, this feature retrieves available information of the logged-in user,\nsuch as emails, document numbers, phone numbers, addresses, and other profile details."},"FeatureDirectDebitsReadRequest":{"properties":{"code":{"type":"string","const":"direct_debits_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Direct Debits Read","description":"Feature that retrieves direct debit information.\n\nProvides access to:\n- Direct debit mandates\n- Transaction history\n- Merchant details\n- Authorization status"},"FeatureDriverDataReadRequest":{"properties":{"code":{"type":"string","const":"driver_data","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__driver_data__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Driver & Vehicles Data","description":"Feature that retrieves the driver data from public administrations."},"FeatureInvestmentAccountsReadRequest":{"properties":{"code":{"type":"string","const":"investment_accounts_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Investment Accounts Read","description":"Feature that retrieves investment account information.\n\nProvides access to:\n- Investment portfolio details\n- Account balances and positions\n- Investment performance"},"FeatureLaborCheckReadRequest":{"properties":{"code":{"type":"string","const":"labor_check","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__labor_check__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Labor Check","description":"Feature that extracts labor check information from public services.\n\nWhen requested from engines like TGSS (Spain), it will fetch and parse:\n- Labor history (\"Vida Laboral\") PDF document\n- Monthly social security contributions\n- Employment history with companies\n- Other labor-related information"},"FeaturePensionPlansReadRequest":{"properties":{"code":{"type":"string","const":"pensions_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Pension Plans Read","description":"Feature that retrieves pension plan information."},"FeaturePropertiesDataReadRequest":{"properties":{"code":{"type":"string","const":"properties_data","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__properties_data__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Properties Data","description":"Feature that retrieves the properties associated with the person."},"FeaturePublicPensionReadRequest":{"properties":{"code":{"type":"string","const":"public_pensions","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Public Pensions","description":"Feature that retrieves public pension information from government services.\n\nFetches details about:\n- Retirement pensions and benefits \n- Widow/survivor pensions\n- Disability/incapacity benefits\n- Other government social assistance\n- Pension type, category and amounts"},"FeatureStateSchema":{"properties":{"code":{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Feature code"},"status_reason":{"type":"string","enum":["FEATURE_ACCEPTED","FEATURE_WAITING","FEATURE_RUNNING","FEATURE_ACTION_REQUIRED","FEATURE_ACTION_REJECTED","FEATURE_INCORRECT_PARAMETERS_FORMAT","FEATURE_ABORTED","FEATURE_TIMEOUT","FEATURE_ACTION_TIMEOUT","FEATURE_CUSTOMER_INTERVENTION_REQUIRED","FEATURE_CONFIGURATION_ERROR","FEATURE_COMPLETED","FEATURE_PARTIAL","FEATURE_FAILED","FEATURE_DISABLED","FEATURE_NOT_IMPLEMENTED","FEATURE_TEMPORARY_ERROR","FEATURE_INTERNAL_ERROR"],"title":"FeatureReason","description":"Feature status reason"},"status_message":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Status Message","description":"Feature status message if any"}},"type":"object","required":["code","status_reason"],"title":"Feature State"},"FeatureSupplierInvoicesReadRequest":{"properties":{"code":{"type":"string","const":"supplier_invoices_read","title":"Code"},"configurations":{"$ref":"#/components/schemas/InvoicesReadConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Supplier Invoices Read","description":"Feature that retrieves invoices from the source engine.\n\nThe feature will fetch and parse:\n- Invoice documents and details\n- Invoice amounts and dates\n- Supplier/customer information \n- Payment and tax information\n- Other invoice-related data"},"FeatureVerifyPublicDocumentRequest":{"properties":{"code":{"type":"string","const":"public_document_verification","title":"Code"},"configurations":{"$ref":"#/components/schemas/IFeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Public Document Verification","description":"Feature that verifies the authenticity of public documents.\n\nPerforms verification of:\n- Document validity\n- Digital signatures\n- Document integrity\n- Issuing authority verification"},"FeatureYearlyIndividualTaxRequest":{"properties":{"code":{"type":"string","const":"yearly_individual_tax","title":"Code"},"configurations":{"$ref":"#/components/schemas/catgrid_forms__engines__features__public__yearly_individual_tax__FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Yearly Taxes for Individuals","description":"Feature that retrieves annual tax information for individuals from tax authorities.\nObtains:\n- Annual tax declarations\n- Tax payment status\n- Tax assessment summaries"},"FileAttachmentSchema":{"properties":{"product":{"type":"string","const":"attachment","title":"Product","default":"attachment"},"sub_family":{"type":"string","enum":["attachment:attachment","attachment:supplier_invoice","attachment:client_invoice","attachment:es-tgss-life-report","attachment:es-aeat-model-100"],"title":"ProductAttachmentType","description":"Product Attachment Type\nAllowed values are:\n - `attachment:attachment`: Generic Attachment\n- `attachment:supplier_invoice`: Supplier Invoice\n- `attachment:client_invoice`: Supplier Invoice\n- `attachment:es-tgss-life-report`: Spain / TGSS / Work Life Report\n- `attachment:es-aeat-model-100`: Spain / AEAT / Model 100"},"id":{"type":"string","format":"ObjectId","title":"Id","description":"Attachment ID, used to download the file.","examples":["644599da47847b79c03cc94f"]},"content_name":{"type":"string","title":"Content Name","description":"Content name"},"content_hash":{"type":"string","title":"Content Hash","description":"Content hash"},"content_type":{"type":"string","format":"mime-type","title":"Content Type","description":"Content type","examples":["application/json","application/pdf","image/jpeg","text/plain"]},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Additional metadata"}},"type":"object","required":["sub_family","id","content_name","content_type","metadata"],"title":"File Attachment"},"FinancialGlobalPositionSchema":{"properties":{"customer":{"$ref":"#/components/schemas/CustomerFamily","description":"Customer family"},"accounts":{"items":{"$ref":"#/components/schemas/CurrentAccountSchema"},"type":"array","title":"Accounts","description":"Current accounts"},"cards":{"items":{"anyOf":[{"$ref":"#/components/schemas/CreditCardSchema"},{"$ref":"#/components/schemas/DebitCardSchema"},{"$ref":"#/components/schemas/PrepaidCardSchema"}]},"type":"array","title":"Cards","description":"Cards"},"deposits":{"items":{"anyOf":[{"$ref":"#/components/schemas/TimeDepositSchema"},{"$ref":"#/components/schemas/SavingsGoalSchema"}]},"type":"array","title":"Deposits","description":"Deposits"},"investments":{"$ref":"#/components/schemas/InvestmentsFamily","description":"Investments family"},"loans":{"items":{"anyOf":[{"$ref":"#/components/schemas/PersonalLoanSchema"},{"$ref":"#/components/schemas/MortgageSchema"}]},"type":"array","title":"Loans","description":"Loans"},"direct_debits":{"items":{"$ref":"#/components/schemas/SEPADirectDebitSchema"},"type":"array","title":"Direct Debits","description":"Direct debits"}},"type":"object","title":"Financial Global Position"},"GenericIdentifierSchema":{"properties":{"type":{"type":"string","const":"generic","title":"Type"},"value":{"type":"string","title":"Value","description":"Identifier","examples":["123.456-7890"]},"entity_country":{"type":"string","format":"country","title":"Entity Country","description":"Entity country","examples":["ES","US"]},"entity_code":{"type":"string","title":"Entity Code","description":"Entity code"},"entity_office":{"type":"string","title":"Entity Office","description":"Entity office"},"control_digits":{"type":"string","title":"Control Digits","description":"Control digits"}},"type":"object","required":["type","value"],"title":"Generic Identifier","description":"Generic account identifier"},"GenericSourceContractSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Contract ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"source_contract","title":"Product"},"sub_family":{"type":"string","const":"source_contract:generic_contract","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"contract_number":{"type":"string","title":"Contract Number","description":"Contract number"},"contract_name":{"type":"string","title":"Contract Name","description":"Contract name"},"contract_description":{"type":"string","title":"Contract Description","description":"Contract description"},"contract_date":{"type":"string","format":"date","title":"Contract Date","description":"Contract date"},"contract_address":{"$ref":"#/components/schemas/AddressSchema","description":"Contract address"}},"type":"object","required":["id","product","sub_family","fetch_date"],"title":"Source Contract"},"HigherEducationSchema":{"properties":{"product":{"type":"string","const":"academic_data","title":"Product"},"sub_family":{"type":"string","enum":["academic_data:higher_bachelor","academic_data:higher_master","academic_data:higher_doctorate"],"title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"qualification_name":{"type":"string","title":"Qualification Name","description":"Qualification name."},"institution_name":{"type":"string","title":"Institution Name","description":"Institution name."},"institution_country":{"type":"string","format":"country","title":"Institution Country","description":"Country of the institution.","examples":["ES","US"]},"completion_status":{"type":"string","title":"Completion Status","description":"Completion status"},"issue_date":{"type":"string","format":"date","title":"Issue Date","description":"Date when the qualification was issued."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Date when the education started."},"end_date":{"type":"string","format":"date","title":"End Date","description":"Date when the education ended."},"official_id":{"type":"string","title":"Official Id","description":"National registry number / Diploma serial number."},"verification_url":{"type":"string","title":"Verification Url","description":"Link to public administration validator."},"thesis_title":{"type":"string","title":"Thesis Title","description":"Thesis title - Mandatory for PhD, common for Master"},"field_of_study":{"type":"string","title":"Field Of Study","description":"ISCED-F code or name (e.g., \"061 ICTs\")"},"total_credits":{"type":"string","format":"number","title":"Total Credits","description":"ECTS credits (Common in Europe)","examples":["1.00","NaN"]},"grade_average":{"type":"string","format":"number","title":"Grade Average","description":"GPA or local scale (e.g., 0-10 in Spain)","examples":["1.00","NaN"]}},"type":"object","required":["product","sub_family","fetch_date","qualification_name","institution_name","institution_country","completion_status","total_credits","grade_average"],"title":"Higher Education (Bachelor, Master, PhD)"},"IBANIdentifierSchema":{"properties":{"type":{"type":"string","const":"iban","title":"Type"},"value":{"type":"string","format":"IBAN","title":"Value","description":"International Bank Account Number","examples":["ES8284670183511835325070","ES8284670183511835325070"]},"masked":{"type":"string","maxLength":34,"minLength":1,"title":"Masked","description":"Partial IBAN"},"entity_country":{"type":"string","title":"Entity Country","description":"Bank Country","readOnly":true},"entity_code":{"type":"string","title":"Entity Code","description":"Bank code","readOnly":true},"entity_office":{"type":"string","title":"Entity Office","description":"Bank office","readOnly":true},"control_digits":{"type":"string","title":"Control Digits","description":"Control digits","readOnly":true}},"type":"object","required":["type","value","masked","entity_country","entity_code","entity_office","control_digits"],"title":"IBAN","description":"International Bank Account Number"},"IFeatureConfigurations":{"properties":{},"type":"object","title":"No configuration required","description":"This feature does not require any configuration"},"IdentificationNumberSchema":{"properties":{"type":{"type":"string","enum":["unknown","es:dni","es:nie","es:cif","es:ssn","co:cc","co:ce","co:nit","co:ti"],"title":"IdentificationNumberType","description":"Type of identification number"},"value":{"type":"string","title":"Value","description":"Identification number","examples":["12345678A"]},"validated":{"type":"boolean","title":"Validated","description":"Indicates if the number has been validated"},"country":{"type":"string","format":"country","title":"Country","description":"Country of the identification number","examples":["ES","US"]},"valid_until":{"type":"string","format":"date","title":"Valid Until","description":"Date until the number is valid"}},"type":"object","required":["type","value","validated"],"title":"Identification Number","description":"Model representing an identification number"},"IncomeDetails":{"properties":{"employment":{"$ref":"#/components/schemas/EmploymentIncome","description":"Employment income details"},"capital":{"$ref":"#/components/schemas/CapitalIncome","description":"Capital income details"},"capital_gains":{"$ref":"#/components/schemas/CapitalGains","description":"Capital gains and losses details"},"business":{"$ref":"#/components/schemas/BusinessIncome","description":"Business activity income details"},"real_estate":{"$ref":"#/components/schemas/RealEstateIncome","description":"Real estate/rental income details"}},"type":"object","required":["employment","capital","capital_gains","business","real_estate"],"title":"Yearly Fiscal Data / Persons / Income Details"},"InputRequiredFieldsGroupSchema":{"properties":{"$defs":{"additionalProperties":true,"type":"object","title":"$Defs","description":"Definitions"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Properties of the form"},"required":{"items":{"type":"string"},"type":"array","title":"Required","description":"List of required fields"},"type":{"type":"string","const":"object","title":"Type","description":"Type of the form"},"format":{"type":"string","const":"cg-action-required","title":"Format","description":"Type of form"},"x-meta":{"$ref":"#/components/schemas/catgrid_core__schemas__ui__field_group__InputRequiredFieldsGroupSchema__XMeta","description":"Meta information of the form"}},"additionalProperties":true,"type":"object","required":["properties","type","format"],"title":"Input Required Form","description":"Model representing a group of fields for MFA required, intended to be used with MFA actions."},"InvestmentAccountSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_account","title":"Product"},"sub_family":{"type":"string","const":"financial_account:investments","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"data_enrichment":{"type":"string","enum":["skipped","pending","processing","ready","failed"],"title":"DataEnrichmentStatus","description":"Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data."},"identifier":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Identifier","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"opening_date":{"type":"string","format":"date","title":"Opening Date","description":"Account opening date"},"valuation_date":{"type":"string","format":"date","title":"Valuation Date","description":"Valuation date"},"valuation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Valuation of the assets held in the account. (Deprecated, use `balance` instead)"},"appreciation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Monetary appreciation of the assets held in the account"},"performance":{"$ref":"#/components/schemas/Rate","description":"Account performance"}},"type":"object","required":["id","product","sub_family","fetch_date","data_enrichment","identifier","customer_segment","product_name"],"title":"Investment Account"},"InvestmentFundSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"investment_asset","title":"Product"},"sub_family":{"type":"string","enum":["investment_asset:fund","investment_asset:etf","investment_asset:mutual","investment_asset:closed"],"title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"contract":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Contract if present"},"account":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"isin":{"type":"string","title":"Isin","description":"ISIN code"},"ticker":{"type":"string","title":"Ticker","description":"Ticker"},"market":{"type":"string","title":"Market","description":"Market"},"category":{"type":"string","title":"Category","description":"Category"},"unit_price":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__2","description":"Unit price"},"quantity":{"type":"string","format":"number","title":"Quantity","description":"The number of units of a financial instrument held by the account.","default":"nan","examples":["1.000000","NaN"]},"valuation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The monetary value of a financial instrument held by the account."},"valuation_date":{"type":"string","format":"date","title":"Valuation Date","description":"Valuation date"},"appreciation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The monetary value of the appreciation of a financial instrument held by the account."},"performance":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Performance"}},"type":"object","required":["id","product","sub_family","fetch_date","account","customer_segment","product_name"],"title":"Investments Fund"},"InvestmentStockSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"investment_asset","title":"Product"},"sub_family":{"type":"string","const":"investment_asset:stock","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"contract":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Contract if present"},"account":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"isin":{"type":"string","title":"Isin","description":"ISIN code"},"ticker":{"type":"string","title":"Ticker","description":"Ticker"},"market":{"type":"string","title":"Market","description":"Market"},"category":{"type":"string","title":"Category","description":"Category"},"unit_price":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__2","description":"Unit price"},"quantity":{"type":"string","format":"number","title":"Quantity","description":"The number of units of a financial instrument held by the account.","default":"nan","examples":["1.000000","NaN"]},"valuation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The monetary value of a financial instrument held by the account."},"valuation_date":{"type":"string","format":"date","title":"Valuation Date","description":"Valuation date"},"appreciation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The monetary value of the appreciation of a financial instrument held by the account."},"performance":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Performance"}},"type":"object","required":["id","product","sub_family","fetch_date","account","customer_segment","product_name"],"title":"Investments Stock"},"InvestmentsFamily":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/InvestmentAccountSchema"},"type":"array","title":"Accounts","description":"Investment accounts"},"stocks":{"items":{"$ref":"#/components/schemas/InvestmentStockSchema"},"type":"array","title":"Stocks","description":"Investment stocks"},"funds":{"items":{"$ref":"#/components/schemas/InvestmentFundSchema"},"type":"array","title":"Funds","description":"Investment funds"},"pensions":{"items":{"$ref":"#/components/schemas/PensionPlanSchema"},"type":"array","title":"Pensions","description":"Pension plans"}},"type":"object","title":"Investments Family"},"InvoicesReadConfigurations":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","description":"The date from which the sub-product will be read","default":"30 days ago","examples":["2023-04-12"]},"to_date":{"type":"string","format":"date","title":"To Date","description":"The date until which the sub-product will be read","default":"today","examples":["2023-04-12"]},"limits_behaviour":{"type":"string","enum":["error","adapt"],"title":"Limits Behaviour","description":"The behaviour when the date limits are not respected.\n- `error`: raise an error and abort the execution\n- `adapt`: adapt the dates to the limits and continue the execution","default":"error"}},"type":"object","title":"Invoices Read Configurations"},"LiabilityDetails":{"properties":{"real_estate_loans":{"items":{"$ref":"#/components/schemas/RealEstateLoanLine"},"type":"array","title":"Real Estate Loans","description":"List of real estate loans","default":[]}},"type":"object","title":"Yearly Fiscal Data / Persons / Liability Details"},"LiveObjectSchema":{"properties":{"last_ping_date":{"type":"string","format":"datetime","title":"Last Ping Date","description":"Last seen date","examples":["2023-10-05T14:46:36.546596Z"]}},"type":"object","title":"Availability Information","description":"Properties for objects whit ping behavior, defines a last ping date"},"LockableSchema":{"properties":{"reason":{"type":"string","title":"Reason","description":"Reason of the lock"},"date":{"type":"string","format":"date-time","title":"Date","description":"Date of the lock"},"blocker":{"type":"string","format":"ObjectId","title":"Blocker","description":"Blocker of the lock","examples":["644599da47847b79c03cc94f"]},"is_locked":{"type":"boolean","title":"Is Locked","description":"Indicate if the object is locked","readOnly":true}},"type":"object","required":["is_locked"],"title":"Lock Information","description":"Lockable properties for objects, defines a reason, a date and a blocker. If date exists, the object is locked"},"MFARequiredFieldsGroupSchema":{"properties":{"$defs":{"additionalProperties":true,"type":"object","title":"$Defs","description":"Definitions"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Properties of the form"},"required":{"items":{"type":"string"},"type":"array","title":"Required","description":"List of required fields"},"type":{"type":"string","const":"object","title":"Type","description":"Type of the form"},"format":{"type":"string","const":"cg-action-required","title":"Format","description":"Type of form"},"x-meta":{"$ref":"#/components/schemas/XMeta","description":"Meta information of the form"}},"additionalProperties":true,"type":"object","required":["properties","type","format"],"title":"MFA Required Form","description":"Model representing a group of fields for MFA required, intended to be used with MFA actions."},"MarketPlaceEngineDetailsSchema":{"properties":{"reference":{"type":"string","format":"engine-reference","title":"Engine Reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"engine_code":{"type":"string","maxLength":24,"minLength":24,"pattern":"^[A-Z0-9_]{24}$","format":"engine-code","title":"Engine Code","description":"Engine Code","examples":["CATGRIDENTITFIN100ES9999"]},"engine_alternative":{"type":"string","enum":["website","mobile","api","other"],"title":"EngineAlternative","description":"Engines can have multiple alternatives, each alternative is a different implementation for the same provider, but using a different platform or technology. For example there can be two alternatives for a financial institution, one for a website and another for the mobile app of the same institution. Note that two alternatives of the same engine can retrieve different information, based on the availability of the information in the platform or technology used by the alternative.\nAllowed values are:\n - `website`: Alternative for website source\n- `mobile`: Alternative for mobile source\n- `api`: Alternative for oficial api source\n- `other`: Alternative for custom implementation"},"engine_version":{"type":"string","format":"semantic-version","title":"Engine Version","examples":["1.1.1","1.1.1-alpha","1.1.1-alpha.1","1.1.1-0.3.7","1.1.1-x.7.z.92"]},"environment":{"$ref":"#/components/schemas/AppEnvironment"},"status":{"type":"string","enum":["draft","implementing","published","partial","maintenance"],"title":"EngineStatus","description":"The engine status indicates the current state of the engine\nAllowed values are:\n - `draft`: Engine is planned but not developed\n- `implementing`: Engine is being developed\n- `published`: Engine is published and available\n- `partial`: Engine is available but not all features are available or working properly\n- `maintenance`: Engine is published but is under maintenance"},"priority":{"type":"integer","title":"Priority","description":"Priority of the engine (For ordering purposes)"},"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords","description":"Keywords that can be used to search"},"color_primary":{"$ref":"#/components/schemas/ThemeColorSetSchema","description":"Primary theme color"},"main_category":{"type":"string","enum":["financial","public","commercial","cloud","other"],"title":"EngineCategory","description":"Main Category of the engine normally related to the actions that the engine can performon the provider source or the kind of information that the engine can retrieve"},"sub_categories":{"items":{"anyOf":[{"type":"string","enum":["financial:retail","financial:corporate","financial:private","financial:investment","financial:retailer_service"],"title":"FinancialType","description":"Type of financial institution\nAllowed values are:\n - `financial:retail`: Retail Bank\n- `financial:corporate`: Corporate Bank\n- `financial:private`: Private Bank\n- `financial:investment`: Investments Services\n- `financial:retailer_service`: Retailer Financial Services"},{"type":"string","enum":["public:cmf_chile","public:afc_chile","public:sii_chile","public:aeat_spain","public:tgss_spain","public:sgad_spain","public:dgt_spain","public:bde_spain","public:dian_colombia"],"title":"PublicType","description":"Type of public administration institution\nAllowed values are:\n - `public:cmf_chile`: Comisión para el Mercado Financiero (Chile)\n- `public:afc_chile`: Administradora de Fondos de Cesantía (Chile)\n- `public:sii_chile`: Servicio de Impuestos Internos (Chile)\n- `public:aeat_spain`: Agencia Estatal de Administración Tributaria (España)\n- `public:tgss_spain`: Tesorería General de la Seguridad Social (España)\n- `public:sgad_spain`: Secretaría General de Administración Digital (España)\n- `public:dgt_spain`: Dirección General de Tecnologías de la Información y Comunicaciones (España)\n- `public:bde_spain`: Banco de España\n- `public:dian_colombia`: Dirección de Impuestos y Aduanas Nacionales (Colombia)"},{"type":"string","enum":["commercial:telecom","commercial:energy","commercial:tech_services","commercial:digital_content","commercial:retail","commercial:ecommerce","commercial:logistics","commercial:healthcare","commercial:hospitality","commercial:construction","commercial:manufacturing"],"title":"CommercialType","description":"Type of commercial institution\nAllowed values are:\n - `commercial:telecom`: Telecom Services\n- `commercial:energy`: Utilities & Energy\n- `commercial:tech_services`: Technology Services\n- `commercial:digital_content`: Digital Content & Streaming\n- `commercial:retail`: Retail\n- `commercial:ecommerce`: E-commerce\n- `commercial:logistics`: Logistics & Transportation\n- `commercial:healthcare`: Healthcare Services\n- `commercial:hospitality`: Hospitality & Tourism\n- `commercial:construction`: Construction & Real Estate\n- `commercial:manufacturing`: Manufacturing"},{"type":"string","enum":["other:other"],"title":"OtherType","description":"Other type of institution\nAllowed values are:\n - `other:other`: Other"}]},"type":"array","title":"Sub Categories","description":"Sub Categories of the engine normally based on the kind of actions that the engine can perform on the provider source or the kind of information that the engine can retrieve"},"name":{"type":"string","title":"Name","description":"Formal name of the engine","examples":["Demo Bank"]},"description":{"type":"string","title":"Description","description":"Brief description of the engine","examples":["Engine for mock testing purposes"]},"markets":{"items":{"type":"string","format":"country","examples":["ES","US"]},"type":"array","title":"Markets","description":"Markets where the engine is oriented, can be used to filter the target audience of the engine"},"website":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Website","description":"Provider's website","examples":["https://www.example.com"]},"languages":{"items":{"type":"string","format":"language","title":"Language <ISO 639-2>","examples":["eng","spa"]},"type":"array","title":"Languages","description":"Languages supported by the provider"},"engine_restrictions":{"items":{"type":"string"},"type":"array","title":"Engine Restrictions","description":"Known engine restrictions","examples":[["Engine does not support transactions retrieval during the day"]]},"engine_issues":{"items":{"type":"string"},"type":"array","title":"Engine Issues","description":"Known engine issues"},"action_required_frequency":{"type":"string","enum":["unknown","never","on_first_use","rarely","often","always"],"title":"ActionRequiredFrequency","description":"Frequency with which action required events, are triggered\nAllowed values are:\n - `unknown`: unknown\n- `never`: never\n- `on_first_use`: on first use\n- `rarely`: rarely\n- `often`: often\n- `always`: always"},"features":{"items":{"$ref":"#/components/schemas/EngineFeatureDetailsSchema"},"type":"array","title":"Features","description":"Details for each feature allowed by the engine. Specifies the possible events raised by the feature and the allowed configurations."},"live":{"$ref":"#/components/schemas/LiveObjectSchema","description":"Information about the availability of the engine"},"events":{"items":{"type":"string","enum":["started","action_required","ended","auth_ended"],"title":"ExecutionEventType","description":"The type of event that is being reported\nAllowed values are:\n - `started`: Execution has started\n- `action_required`: Execution requires an action (Ex: MFA)\n- `ended`: Execution has ended\n- `auth_ended`: Authentication has ended"},"type":"array","title":"Events","description":"Possible Events raised by the current engine. You can subscribe to the desired events to receive notifications and status updates about the execution of the engine.\nAllowed values are:\n - `started`: Execution has started\n- `action_required`: Execution requires an action (Ex: MFA)\n- `ended`: Execution has ended\n- `auth_ended`: Authentication has ended"},"parameters":{"$ref":"#/components/schemas/ParametersFieldsGroupSchema","description":"Description of the engine parameters in OpenAPI 3.0.3 Schema Object format"},"configurations":{"$ref":"#/components/schemas/ConfigurationsFieldsGroupSchema","description":"Description of the engine configurations in OpenAPI 3.0.3 Schema Object format"},"is_online":{"type":"boolean","title":"Is Online","description":"Indicate if the engine is online","readOnly":true}},"type":"object","required":["reference","engine_code","engine_alternative","engine_version","environment","status","priority","keywords","color_primary","main_category","sub_categories","name","description","markets","languages","engine_restrictions","engine_issues","action_required_frequency","live","events","parameters","configurations","is_online"],"title":"Marketplace Engine Details","description":"Detailed information of an engine, this information is used to describe the engine configurations,\nparameters, and features."},"MarketPlaceEngineSchema":{"properties":{"reference":{"type":"string","format":"engine-reference","title":"Engine Reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"engine_code":{"type":"string","maxLength":24,"minLength":24,"pattern":"^[A-Z0-9_]{24}$","format":"engine-code","title":"Engine Code","description":"Engine Code","examples":["CATGRIDENTITFIN100ES9999"]},"engine_alternative":{"type":"string","enum":["website","mobile","api","other"],"title":"EngineAlternative","description":"Engines can have multiple alternatives, each alternative is a different implementation for the same provider, but using a different platform or technology. For example there can be two alternatives for a financial institution, one for a website and another for the mobile app of the same institution. Note that two alternatives of the same engine can retrieve different information, based on the availability of the information in the platform or technology used by the alternative.\nAllowed values are:\n - `website`: Alternative for website source\n- `mobile`: Alternative for mobile source\n- `api`: Alternative for oficial api source\n- `other`: Alternative for custom implementation"},"engine_version":{"type":"string","format":"semantic-version","title":"Engine Version","examples":["1.1.1","1.1.1-alpha","1.1.1-alpha.1","1.1.1-0.3.7","1.1.1-x.7.z.92"]},"environment":{"$ref":"#/components/schemas/AppEnvironment"},"status":{"type":"string","enum":["draft","implementing","published","partial","maintenance"],"title":"EngineStatus","description":"The engine status indicates the current state of the engine\nAllowed values are:\n - `draft`: Engine is planned but not developed\n- `implementing`: Engine is being developed\n- `published`: Engine is published and available\n- `partial`: Engine is available but not all features are available or working properly\n- `maintenance`: Engine is published but is under maintenance"},"priority":{"type":"integer","title":"Priority","description":"Priority of the engine (For ordering purposes)"},"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords","description":"Keywords that can be used to search"},"color_primary":{"$ref":"#/components/schemas/ThemeColorSetSchema","description":"Primary theme color"},"main_category":{"type":"string","enum":["financial","public","commercial","cloud","other"],"title":"EngineCategory","description":"Main Category of the engine normally related to the actions that the engine can performon the provider source or the kind of information that the engine can retrieve"},"sub_categories":{"items":{"anyOf":[{"type":"string","enum":["financial:retail","financial:corporate","financial:private","financial:investment","financial:retailer_service"],"title":"FinancialType","description":"Type of financial institution\nAllowed values are:\n - `financial:retail`: Retail Bank\n- `financial:corporate`: Corporate Bank\n- `financial:private`: Private Bank\n- `financial:investment`: Investments Services\n- `financial:retailer_service`: Retailer Financial Services"},{"type":"string","enum":["public:cmf_chile","public:afc_chile","public:sii_chile","public:aeat_spain","public:tgss_spain","public:sgad_spain","public:dgt_spain","public:bde_spain","public:dian_colombia"],"title":"PublicType","description":"Type of public administration institution\nAllowed values are:\n - `public:cmf_chile`: Comisión para el Mercado Financiero (Chile)\n- `public:afc_chile`: Administradora de Fondos de Cesantía (Chile)\n- `public:sii_chile`: Servicio de Impuestos Internos (Chile)\n- `public:aeat_spain`: Agencia Estatal de Administración Tributaria (España)\n- `public:tgss_spain`: Tesorería General de la Seguridad Social (España)\n- `public:sgad_spain`: Secretaría General de Administración Digital (España)\n- `public:dgt_spain`: Dirección General de Tecnologías de la Información y Comunicaciones (España)\n- `public:bde_spain`: Banco de España\n- `public:dian_colombia`: Dirección de Impuestos y Aduanas Nacionales (Colombia)"},{"type":"string","enum":["commercial:telecom","commercial:energy","commercial:tech_services","commercial:digital_content","commercial:retail","commercial:ecommerce","commercial:logistics","commercial:healthcare","commercial:hospitality","commercial:construction","commercial:manufacturing"],"title":"CommercialType","description":"Type of commercial institution\nAllowed values are:\n - `commercial:telecom`: Telecom Services\n- `commercial:energy`: Utilities & Energy\n- `commercial:tech_services`: Technology Services\n- `commercial:digital_content`: Digital Content & Streaming\n- `commercial:retail`: Retail\n- `commercial:ecommerce`: E-commerce\n- `commercial:logistics`: Logistics & Transportation\n- `commercial:healthcare`: Healthcare Services\n- `commercial:hospitality`: Hospitality & Tourism\n- `commercial:construction`: Construction & Real Estate\n- `commercial:manufacturing`: Manufacturing"},{"type":"string","enum":["other:other"],"title":"OtherType","description":"Other type of institution\nAllowed values are:\n - `other:other`: Other"}]},"type":"array","title":"Sub Categories","description":"Sub Categories of the engine normally based on the kind of actions that the engine can perform on the provider source or the kind of information that the engine can retrieve"},"name":{"type":"string","title":"Name","description":"Formal name of the engine","examples":["Demo Bank"]},"description":{"type":"string","title":"Description","description":"Brief description of the engine","examples":["Engine for mock testing purposes"]},"markets":{"items":{"type":"string","format":"country","examples":["ES","US"]},"type":"array","title":"Markets","description":"Markets where the engine is oriented, can be used to filter the target audience of the engine"},"website":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Website","description":"Provider's website","examples":["https://www.example.com"]},"languages":{"items":{"type":"string","format":"language","title":"Language <ISO 639-2>","examples":["eng","spa"]},"type":"array","title":"Languages","description":"Languages supported by the provider"},"engine_restrictions":{"items":{"type":"string"},"type":"array","title":"Engine Restrictions","description":"Known engine restrictions","examples":[["Engine does not support transactions retrieval during the day"]]},"engine_issues":{"items":{"type":"string"},"type":"array","title":"Engine Issues","description":"Known engine issues"},"action_required_frequency":{"type":"string","enum":["unknown","never","on_first_use","rarely","often","always"],"title":"ActionRequiredFrequency","description":"Frequency with which action required events, are triggered\nAllowed values are:\n - `unknown`: unknown\n- `never`: never\n- `on_first_use`: on first use\n- `rarely`: rarely\n- `often`: often\n- `always`: always"},"features":{"items":{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"},"type":"array","title":"Features","description":"List of features that the engine allows. Each feature is a type of action that the engine can perform"},"live":{"$ref":"#/components/schemas/LiveObjectSchema","description":"Information about the availability of the engine"},"is_online":{"type":"boolean","title":"Is Online","description":"Indicate if the engine is online","readOnly":true}},"type":"object","required":["reference","engine_code","engine_alternative","engine_version","environment","status","priority","keywords","color_primary","main_category","sub_categories","name","description","markets","languages","engine_restrictions","engine_issues","action_required_frequency","features","live","is_online"],"title":"Marketplace Engine Schema","description":"Model with the information of an engine, an engine can be interpreted as a source of information.\nEach engine is identified by a unique code and an alternative and implements various features\nfor different purposes, such as data retrieval, data enrichment, data validation, etc.\n<br/>\nEngines contain categories and subcategories that help to identify the general purpose of the engine.\nYou can also use the market to which the engine is oriented, the status of the engine, and the environments\nin which the engine is available.\n<br/>\nEngines can only be executed by client applications that have been granted access to them and that are\ncompatible with the engine's environments."},"MessageSchema":{"properties":{"id":{"type":"string","maxLength":64,"title":"Id","description":"Title of the message","examples":["New user created"]},"date":{"type":"string","format":"datetime","title":"Date","description":"Date of the message","examples":["2023-10-05T14:46:36.546596Z"]},"type":{"type":"string","enum":["error","info","warning","notification"],"title":"MessageType","description":"Type of message"},"loc":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array","title":"Loc","default":[]},"message":{"type":"string","maxLength":1024,"title":"Message","description":"Message content","examples":["A new user has been created"]}},"type":"object","required":["date","type"],"title":"Message Model","description":"Message model used by the notifications system"},"MortgageSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_loan","title":"Product"},"sub_family":{"type":"string","const":"financial_loan:mortgage","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Loan identifier"},"linked_account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Linked account"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"initial_balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Initial balance of the loan"},"outstanding_balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Outstanding balance of the loan"},"next_payment_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Next payment amount"},"begin_date":{"type":"string","format":"date","title":"Begin Date","description":"Loan start date"},"renovation_date":{"type":"string","format":"date","title":"Renovation Date","description":"Renovation Date"},"end_date":{"type":"string","format":"date","title":"End Date","description":"Loan expected end date"},"next_payment_date":{"type":"string","format":"date","title":"Next Payment Date","description":"Next payment date"},"interest_rate":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Loan interest rate"},"current_period":{"type":"integer","title":"Current Period","description":"Current period"},"pending_periods":{"type":"integer","title":"Pending Periods","description":"Pending periods"},"total_periods":{"type":"integer","title":"Total Periods","description":"Total periods"}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name"],"title":"Mortgage"},"NetEstimationResult":{"properties":{"gross_annual":{"$ref":"#/components/schemas/CurrencyAmount","description":"Annual gross income (EUR)"},"net_annual":{"$ref":"#/components/schemas/CurrencyAmount","description":"Annual net income after SS and IRPF (EUR)"},"net_monthly":{"$ref":"#/components/schemas/CurrencyAmount","description":"Net monthly income (EUR)"},"has_extra_payments":{"type":"boolean","title":"Has Extra Payments","description":"Indicates if there are more than 12 pay periods"},"extra_payment_unit":{"$ref":"#/components/schemas/CurrencyAmount","description":"Unit amount of each extra payment (EUR), 0 if 12 pays"},"annual_withholding":{"$ref":"#/components/schemas/CurrencyAmount","description":"Annual IRPF withholding (EUR)"},"withholding_rate":{"type":"string","format":"number","title":"Withholding Rate","description":"Applied annual withholding rate [0..1]","examples":["1.000000","NaN"]},"annual_worker_ss":{"$ref":"#/components/schemas/CurrencyAmount","description":"Annual worker Social Security (EUR)"}},"type":"object","required":["gross_annual","net_annual","net_monthly","has_extra_payments","extra_payment_unit","annual_withholding","withholding_rate","annual_worker_ss"],"title":"NetEstimationResult"},"PanIdentifierSchema":{"properties":{"type":{"type":"string","const":"pan","title":"Type"},"masked":{"type":"string","maxLength":19,"minLength":1,"title":"Masked","description":"Partial PAN"},"brand":{"$ref":"#/components/schemas/PaymentCardBrand","description":"Card brand"}},"type":"object","required":["type","masked"],"title":"PAN","description":"Primary Account Number"},"ParametersFieldsGroupSchema":{"properties":{"$defs":{"additionalProperties":true,"type":"object","title":"$Defs","description":"Definitions"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Properties of the form"},"required":{"items":{"type":"string"},"type":"array","title":"Required","description":"List of required fields"},"type":{"type":"string","const":"object","title":"Type","description":"Type of the form"},"format":{"type":"string","const":"cg-params","title":"Format","description":"Type of form"},"x-meta":{"$ref":"#/components/schemas/catgrid_core__schemas__ui__field_group__ParametersFieldsGroupSchema__XMeta","description":"Meta information of the form"}},"additionalProperties":true,"type":"object","required":["properties","type","format"],"title":"Parameters Fields Group","description":"Description of the parameters form in OpenAPI 3.0.3 Schema Object, all OpenAPI 3.0.3 Schema Object properties are\nallowed, we detail the ones that are required for the parameters form in this model."},"PayerEstimation":{"properties":{"payer_id":{"type":"string","title":"Payer Id","description":"Identifier of the employer"},"contract_type":{"type":"string","enum":["unknown","permanent","temporary","training","professional_practices","fixed_discontinuous"],"title":"WorkContractType","description":"Contract type with this employer"},"professional_category":{"type":"string","enum":["engineers_graduates","technical_engineers","administrative_chiefs","unqualified_assistants","administrative_officers","subordinates","administrative_assistants","first_and_second_officers","third_officers_and_specialists","laborers","under_eighteen","unknown"],"title":"SpainProfessionalCategory","description":"Professional category with this employer"},"monthly_gross_recent":{"$ref":"#/components/schemas/CurrencyAmount","description":"Average gross from recent months"},"monthly_gross_full":{"$ref":"#/components/schemas/CurrencyAmount","description":"Average gross from full window"},"chosen_monthly_gross":{"$ref":"#/components/schemas/CurrencyAmount","description":"The chosen monthly gross for projection"},"net":{"$ref":"#/components/schemas/NetEstimationResult"}},"type":"object","required":["payer_id","contract_type","professional_category","monthly_gross_recent","monthly_gross_full","chosen_monthly_gross","net"],"title":"PayerEstimation"},"PayerSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Payer name"},"identifier":{"type":"string","title":"Identifier","description":"Payer identifier"}},"type":"object","title":"Direct Debit Payer"},"PaymentCardBrand":{"type":"string","enum":["American Express","Mastercard","Visa","Mir","Maestro","Discover","Verve","Dankort","Troy","UnionPay","JCB","Diners Club","other"],"title":"PaymentCardBrand","description":"Payment card brands supported by the [`PaymentCardNumber`][pydantic_extra_types.payment.PaymentCardNumber]."},"PensionPlanSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"pension_plan","title":"Product"},"sub_family":{"type":"string","enum":["pension_plan:pension"],"title":"PensionPlanType","description":"Pension plan type"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"oneOf":[{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Identifier","description":"Plan number","discriminator":{"propertyName":"type","mapping":{"generic":"#/components/schemas/GenericIdentifierSchema"}}},"linked_account":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"category":{"type":"string","title":"Category","description":"Plan Category"},"begin_date":{"type":"string","format":"date","title":"Begin Date","description":"Begin date"},"end_date":{"type":"string","format":"date","title":"End Date","description":"End Date"},"total_contribution":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total contribution"},"year_to_date_contribution":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Year to date contribution"},"unit_price":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__3","description":"Unit price"},"quantity":{"type":"string","format":"number","title":"Quantity","description":"The number of units of a financial instrument held by the account.","default":"nan","examples":["1.000000","NaN"]},"valuation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The monetary value of a financial instrument held by the account."},"valuation_date":{"type":"string","format":"date","title":"Valuation Date","description":"Valuation date"},"performance":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Total Performance"},"performance_year_to_date":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Year to date performance"},"performance_last_12_months":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Last 12 months performance"},"appreciation":{"$ref":"#/components/schemas/CurrencyAmountSchema","description":"The monetary value of the appreciation of a financial instrument held by the account."}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name"],"title":"Pension Plan"},"PersonalLoanSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_loan","title":"Product"},"sub_family":{"type":"string","const":"financial_loan:personal","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Loan identifier"},"linked_account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Linked account"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"initial_balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Initial balance of the loan"},"outstanding_balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Outstanding balance of the loan"},"next_payment_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Next payment amount"},"begin_date":{"type":"string","format":"date","title":"Begin Date","description":"Loan start date"},"renovation_date":{"type":"string","format":"date","title":"Renovation Date","description":"Renovation Date"},"end_date":{"type":"string","format":"date","title":"End Date","description":"Loan expected end date"},"next_payment_date":{"type":"string","format":"date","title":"Next Payment Date","description":"Next payment date"},"interest_rate":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__2","description":"Loan interest rate"},"current_period":{"type":"integer","title":"Current Period","description":"Current period"},"pending_periods":{"type":"integer","title":"Pending Periods","description":"Pending periods"},"total_periods":{"type":"integer","title":"Total Periods","description":"Total periods"}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name"],"title":"Personal Loan"},"PointMovementSchema":{"properties":{"description":{"type":"string","title":"Description","description":"Description of the movement."},"date":{"type":"string","format":"date","title":"Date","description":"Date of firmness (legal date)."},"effective_date":{"type":"string","format":"date","title":"Effective Date","description":"Effective date of the movement."},"points_delta":{"type":"integer","title":"Points Delta","description":"Points added or subtracted (signed integer)."},"balance_after":{"type":"integer","title":"Balance After","description":"Balance after the movement."},"infraction_reference":{"type":"string","title":"Infraction Reference","description":"Reference number of the infraction."},"infraction_date":{"type":"string","format":"date","title":"Infraction Date","description":"Date of the infraction."},"authority_name":{"type":"string","title":"Authority Name","description":"Name of the authority."},"authority_code":{"type":"string","title":"Authority Code","description":"Code of the authority."}},"type":"object","required":["description","date","points_delta","balance_after"],"title":"Point Movement"},"PrepaidCardSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_card","title":"Product"},"sub_family":{"type":"string","const":"financial_card:prepaid","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"$ref":"#/components/schemas/PanIdentifierSchema","description":"PAN"},"entity_country":{"type":"string","format":"country","title":"Entity Country","description":"Entity country","examples":["ES","US"]},"entity_code":{"type":"string","title":"Entity Code","description":"Entity code"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"holder_name":{"type":"string","title":"Holder Name","description":"Card holder name"},"status":{"type":"string","enum":["unknown","active","cancelled","blocked"],"title":"FinancialCardStatus","description":"Financial Card Status\nAllowed values are:\n - `unknown`: Unknown\n- `active`: Active\n- `cancelled`: Cancelled\n- `blocked`: Blocked"},"expiration_date":{"type":"string","format":"date","title":"Expiration Date","description":"Card expiration date"},"linked_account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Linked Account","description":"Linked account, if proceeds"},"available":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"For cards with a prepaid function, this indicates the current available prepaid balance that a user can access."},"transactions":{"items":{"$ref":"#/components/schemas/CardTransactionSchema"},"type":"array","title":"Transactions","description":"Card transactions"}},"type":"object","required":["id","product","sub_family","fetch_date","identifier","customer_segment","product_name","status"],"title":"Prepaid Card"},"ProductAttachmentSchema":{"properties":{"generation_date":{"type":"string","format":"datetime","title":"Generation Date","description":"Generation date","examples":["2023-10-05T14:46:36.546596Z"]},"content_name":{"type":"string","title":"Content Name","description":"Content name"},"content_hash":{"type":"string","title":"Content Hash","description":"Content hash"},"content_type":{"type":"string","format":"mime-type","title":"Content Type","description":"Content type","examples":["application/json","application/pdf","image/jpeg","text/plain"]}},"type":"object","required":["generation_date","content_name","content_type"],"title":"Product Attachment"},"PropertyOwnerSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Full name of the owner."},"identifier":{"type":"string","title":"Identifier","description":"Identification number of the owner."},"percentage":{"type":"string","format":"number","title":"Percentage","description":"Ownership percentage (e.g., 0.59).","default":"nan","examples":["1.00","NaN"]}},"type":"object","required":["name"],"title":"Property Owner"},"PublicPensionAmountsSchema":{"properties":{"base":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Base pension amount"},"revaluation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Revaluation amount"},"total":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total pension amount. Is the brut amount of the pension, before any deduction"},"net_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Net amount of the pension, after all deductions"}},"type":"object","required":["base","revaluation","total","net_amount"],"title":"Incapacity Pension Amounts"},"Rate":{"properties":{"value":{"type":"string","format":"number","title":"Value","description":"Decimal number with 2 digits precision","default":"NaN","examples":["1.00","NaN"]},"unit":{"anyOf":[{"type":"string","const":"%","title":"%","description":"Rate in percentage"},{"type":"string","format":"currency","examples":["EUR","USD","GBP"]}],"title":"Unit","default":"%"},"description":{"anyOf":[{"type":"string","description":"Description of the rate"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Description"}},"type":"object","title":"Rate"},"RealEstateIncome":{"properties":{"properties":{"items":{"$ref":"#/components/schemas/RealEstateIncomeLine"},"type":"array","title":"Properties","description":"List of rental properties"},"total_gross_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total gross rental income"},"total_net_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total net rental income"}},"type":"object","required":["properties","total_gross_income","total_net_income"],"title":"Yearly Fiscal Data / Persons / Real Estate Income"},"RealEstateIncomeLine":{"properties":{"cadastral_reference":{"type":"string","title":"Cadastral Reference","description":"Cadastral reference of the property"},"address":{"type":"string","title":"Address","description":"Full address of the property"},"gross_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Gross rental income"},"deductible_expenses":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total deductible expenses for this property"},"net_income":{"$ref":"#/components/schemas/CurrencyAmount","description":"Net rental income"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["address","gross_income","deductible_expenses","net_income","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Real Estate Income Line"},"RealEstateLoanLine":{"properties":{"loan_id":{"type":"string","title":"Loan Id","description":"Identifier of the loan"},"lender_id":{"type":"string","title":"Lender Id","description":"Identifier of the lender (NIF/CIF)"},"lender_name":{"type":"string","title":"Lender Name","description":"Name of the lender"},"participation":{"type":"string","format":"number","title":"Participation","description":"Percentage of participation in the loan","default":"nan","examples":["1.00","NaN"]},"amortized_capital":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total amortized capital"},"interests":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total interests paid"},"financial_expenses":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total financial expenses"},"formalization_date":{"type":"string","format":"date","title":"Formalization Date","description":"Date the loan was formalized"},"taxpayer_id":{"type":"string","title":"Taxpayer Id","description":"National identifier of the taxpayer for this line"}},"type":"object","required":["loan_id","lender_id","lender_name","amortized_capital","interests","financial_expenses","taxpayer_id"],"title":"Yearly Fiscal Data / Persons / Real Estate Loan Line"},"ResumeExecutionSchema":{"properties":{},"additionalProperties":true,"type":"object","title":"Resume execution Payload","description":"Payload for resuming an execution that requires user interaction. Can be:<br/>\n- A dictionary with the required fields (values can be optionally encrypted) <br/>\n- An encrypted dictionary in the format `EncryptionType::<encrypted_payload>`"},"SEPADirectDebitSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"direct_debit","title":"Product"},"sub_family":{"type":"string","const":"direct_debit:sepa","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"account":{"oneOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Account identifier","discriminator":{"propertyName":"type","mapping":{"clabe":"#/components/schemas/ClabeIdentifierSchema","generic":"#/components/schemas/GenericIdentifierSchema","iban":"#/components/schemas/IBANIdentifierSchema"}}},"debit_reference":{"type":"string","title":"Debit Reference","description":"Debit reference"},"status":{"type":"string","enum":["unknown","active","cancelled","suspended","expired"],"title":"DirectDebitStatus","description":"Direct Debit status"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"beneficiary":{"$ref":"#/components/schemas/BeneficiarySchema","description":"Beneficiary"},"payer":{"$ref":"#/components/schemas/PayerSchema","description":"Payer"},"transactions":{"items":{"$ref":"#/components/schemas/DirectDebitTransactionSchema"},"type":"array","title":"Transactions","description":"Direct Debit transactions"},"last_attachment":{"$ref":"#/components/schemas/ProductAttachmentSchema","description":"Direct debit last attachment"}},"type":"object","required":["id","product","sub_family","fetch_date","account","status","customer_segment","beneficiary","payer","transactions"],"title":"SEPA Direct Debit"},"SavingsGoalSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_deposit","title":"Product"},"sub_family":{"type":"string","const":"financial_deposit:goal","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Deposit Account"},"contract":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Contract if present"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"available":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The total accessible funds, available for withdrawal."},"balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The amount of founds currently deposited."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Deposit start date"},"last_date":{"type":"string","format":"date","title":"Last Date","description":"Deposit last date"},"interest_rate":{"$ref":"#/components/schemas/Rate","description":"Deposit interest rate"},"goal_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The goal amount of founds to be deposited."}},"type":"object","required":["id","product","sub_family","fetch_date","account","customer_segment","product_name","available","balance"],"title":"Savings Goal"},"SecondaryEducationSchema":{"properties":{"product":{"type":"string","const":"academic_data","title":"Product"},"sub_family":{"type":"string","enum":["academic_data:secondary_general","academic_data:secondary_vocational","academic_data:professional_certification"],"title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"qualification_name":{"type":"string","title":"Qualification Name","description":"Qualification name."},"institution_name":{"type":"string","title":"Institution Name","description":"Institution name."},"institution_country":{"type":"string","format":"country","title":"Institution Country","description":"Country of the institution.","examples":["ES","US"]},"institution_code":{"type":"string","title":"Institution Code","description":"Local school ID or center code."},"region":{"type":"string","title":"Region","description":"State, Province, or Autonomous Community."},"completion_status":{"type":"string","title":"Completion Status","description":"Completion status"},"issue_date":{"type":"string","format":"date","title":"Issue Date","description":"Date when the qualification was issued."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Date when the education started."},"end_date":{"type":"string","format":"date","title":"End Date","description":"Date when the education ended."},"official_id":{"type":"string","title":"Official Id","description":"National registry number / Diploma serial number."},"verification_url":{"type":"string","title":"Verification Url","description":"Link to public administration validator."},"study_framework":{"type":"string","title":"Study Framework","description":"Education system/law (e.g., \"LOE\", \"K-12\", \"GCSE\")"},"national_registry_id":{"type":"string","title":"National Registry Id","description":"National level ID (e.g., MEC in Spain)"},"regional_registry_id":{"type":"string","title":"Regional Registry Id","description":"State/Regional level ID"},"archive_volume":{"type":"string","title":"Archive Volume","description":"Book/Volume number (Libro)"},"archive_entry":{"type":"string","title":"Archive Entry","description":"Entry or order number (Folio/Orden)"}},"type":"object","required":["product","sub_family","fetch_date","qualification_name","institution_name","institution_country","completion_status"],"title":"Secondary & Vocational Education"},"SupplierInvoiceSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Invoice ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"supplier_invoice","title":"Product"},"sub_family":{"type":"string","enum":["supplier_invoice:receipt","supplier_invoice:standard","supplier_invoice:proforma","supplier_invoice:credit_memo","supplier_invoice:debit_memo","supplier_invoice:electronic","supplier_invoice:retail","supplier_invoice:comercial"],"title":"SupplierInvoiceType","description":"Supplier Invoice Type\nAllowed values are:\n - `supplier_invoice:receipt`: Receipt or Simplified Invoice\n- `supplier_invoice:standard`: Standard Invoice\n- `supplier_invoice:proforma`: Proforma Invoice\n- `supplier_invoice:credit_memo`: Credit Memo\n- `supplier_invoice:debit_memo`: Debit Memo\n- `supplier_invoice:electronic`: Electronic Invoice\n- `supplier_invoice:retail`: Retail Invoice\n- `supplier_invoice:comercial`: Comercial Invoice"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"identifier":{"type":"string","title":"Identifier","description":"Invoice number"},"contract":{"type":"string","title":"Contract","description":"Contract if any"},"issue_date":{"type":"string","format":"datetime","title":"Issue Date","description":"Issue date","examples":["2023-10-05T14:46:36.546596Z"]},"due_date":{"type":"string","format":"datetime","title":"Due Date","description":"Due date","examples":["2023-10-05T14:46:36.546596Z"]},"tax_details":{"items":{"$ref":"#/components/schemas/TaxDetailSchema"},"type":"array","title":"Tax Details","description":"Tax details"},"total_tax_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total tax amount"},"total_discount_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total discount amount"},"total_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total amount"},"total_net_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Total net amount"},"issuer":{"$ref":"#/components/schemas/EntityDto","description":"Issuer"},"receiver":{"$ref":"#/components/schemas/EntityDto","description":"Receiver"},"attachments":{"items":{"$ref":"#/components/schemas/FileAttachmentSchema"},"type":"array","title":"Attachments","description":"List of attached supporting documents","default":[]}},"type":"object","required":["id","product","sub_family","fetch_date"],"title":"Supplier Invoice"},"TGSSSpainLaborCheckSalaryEstimationSchema":{"properties":{"payers":{"items":{"$ref":"#/components/schemas/PayerEstimation"},"type":"array","title":"Payers","description":"Estimation details per active payer"},"totals":{"$ref":"#/components/schemas/TotalsEstimation","description":"Aggregated totals for the estimation"},"meta":{"$ref":"#/components/schemas/EstimationMeta","description":"Metadata about the estimation process"}},"type":"object","required":["payers","totals","meta"],"title":"TGSS Spain - Salary Estimation"},"TGSSSpainLaborCheckSchema":{"properties":{"product":{"type":"string","const":"social_security","title":"Product"},"sub_family":{"type":"string","const":"social_security:spain_labor_check","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"currently_active":{"type":"boolean","title":"Currently Active","description":"Currently active"},"social_security_days":{"type":"integer","title":"Social Security Days","description":"Social security days"},"contribution_base_history":{"items":{"$ref":"#/components/schemas/ContributionBaseSchema"},"type":"array","title":"Contribution Base History","description":"Contribution base history"},"work_relations_history":{"items":{"$ref":"#/components/schemas/WorkRelationSchema"},"type":"array","title":"Work Relations History","description":"Work relation history"},"attachments":{"items":{"$ref":"#/components/schemas/FileAttachmentSchema"},"type":"array","title":"Attachments","description":"List of attached supporting documents","default":[]}},"type":"object","required":["product","sub_family","fetch_date","contribution_base_history","work_relations_history"],"title":"TGSS Spain - Labor Check"},"TGSSSpainPublicPensionSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"social_security","title":"Product"},"sub_family":{"type":"string","const":"social_security:spain_public_pension","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"product_name":{"type":"string","title":"Product Name","description":"Product name","examples":["PENSIÓN DE JUBILACIÓN","PENSIÓN DE INCAPACIDAD"]},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias","examples":["Tu pensión de jubilación","Tu pensión de incapacidad"]},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Pension start date *(If proceeds)*"},"regime":{"type":"string","title":"Regime","description":"Pension regime","examples":["General"]},"amounts":{"$ref":"#/components/schemas/PublicPensionAmountsSchema","description":"Pension amounts if is active"}},"type":"object","required":["id","product","sub_family","fetch_date","product_name","start_date","amounts"],"title":"TGSS Spain - Public Pension"},"TaxDetailSchema":{"properties":{"tax_type":{"type":"string","title":"Tax Type","description":"Tax type"},"tax_rate":{"properties":{"decimals":{"type":"integer","title":"Decimals","default":2}},"additionalProperties":false,"type":"object","title":"Tax Rate","description":"Tax rate"},"tax_amount":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"Tax amount"}},"type":"object","title":"Tax Detail"},"ThemeColorSetSchema":{"properties":{"lighter":{"type":"string","format":"color","title":"Lighter","description":"Lighter color"},"light":{"type":"string","format":"color","title":"Light","description":"Light color"},"main":{"type":"string","format":"color","title":"Main","description":"Main color"},"dark":{"type":"string","format":"color","title":"Dark","description":"Dark color"},"darker":{"type":"string","format":"color","title":"Darker","description":"Darker color"},"contrast_text":{"type":"string","format":"color","title":"Contrast Text","description":"Contrast text color"},"contrastText":{"type":"string","format":"color","title":"Contrasttext","description":"Contrast text color"}},"type":"object","required":["lighter","light","main","dark","darker","contrast_text","contrastText"],"title":"Catgrid Theme Colors Set"},"TimeDepositSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Product ID for the current execution. Note: it may change between executions.","examples":["644599da47847b79c03cc94f"]},"product":{"type":"string","const":"financial_deposit","title":"Product"},"sub_family":{"type":"string","const":"financial_deposit:time","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"account":{"anyOf":[{"$ref":"#/components/schemas/IBANIdentifierSchema"},{"$ref":"#/components/schemas/ClabeIdentifierSchema"},{"$ref":"#/components/schemas/GenericIdentifierSchema"}],"title":"Account","description":"Deposit Account"},"contract":{"$ref":"#/components/schemas/GenericIdentifierSchema","description":"Contract if present"},"customer_segment":{"type":"string","enum":["not_assigned","personal","business","corporate","private","retail"],"title":"CustomerSegment","description":"Customer Segment\nAllowed values are:\n - `not_assigned`: Not Assigned\n- `personal`: Personal\n- `business`: Business\n- `corporate`: Corporate\n- `private`: Private\n- `retail`: Retail"},"product_name":{"type":"string","title":"Product Name","description":"Product name"},"product_alias":{"type":"string","title":"Product Alias","description":"Product alias"},"product_description":{"type":"string","title":"Product Description","description":"Product Description"},"available":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The total accessible funds, available for withdrawal."},"balance":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__1","description":"The amount of founds currently deposited."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Deposit start date"},"last_date":{"type":"string","format":"date","title":"Last Date","description":"Deposit last date"},"interest_rate":{"$ref":"#/components/schemas/Rate","description":"Deposit interest rate"}},"type":"object","required":["id","product","sub_family","fetch_date","account","customer_segment","product_name","available","balance"],"title":"Time Deposit"},"ToString_EmailStr_":{"type":"string","format":"email"},"ToString_HttpUrl_":{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},"TokenCredentialContextSchema":{"properties":{"engine_reference":{"type":"string","format":"engine-reference","title":"Engine Reference","description":"Target engine reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"app_id":{"type":"string","format":"ObjectId","title":"App Id","description":"","examples":["644599da47847b79c03cc94f"]},"customer_id":{"type":"string","maxLength":64,"minLength":1,"title":"Customer Id","description":"External customer ID"},"locking_hash":{"type":"string","title":"Locking Hash","description":"Hash of the non-variable part of the credentials, for example, the username"},"features":{"items":{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"},"type":"array","title":"Features","description":"Supported features for the token. Once the token is created, these features cannot be changed, \nyou can request less features if needed, but not include new ones."}},"type":"object","required":["engine_reference","app_id","customer_id","features"],"title":"Credentials Token Context","description":"Represents the context for a credential token.\n\nThis class is used to encapsulate all details required for defining the context\nin which a credential token operates. It includes information such as engine\nreference, application identifier, customer identifier, parameter identifier,\nand supported features. This context ensures a cohesive and structured representation\nof the token's operational scope."},"TokenCredentialResponse":{"properties":{"token_id":{"type":"string","format":"ObjectId","title":"Token Id","description":"Token identifier.","examples":["644599da47847b79c03cc94f"]},"date_created":{"type":"string","format":"datetime","title":"Date Created","description":"Date when the token was created.","examples":["2023-10-05T14:46:36.546596Z"]},"date_expiration":{"type":"string","format":"datetime","title":"Date Expiration","description":"Date when the token expires.","examples":["2023-10-05T14:46:36.546596Z"]},"status_code":{"type":"string","enum":["T10N_DRAFT","T10N_OK","T10N_KO","T10N_REVOKED","T10N_SYSTEM_LOCK","T10N_LOGIN_LOCK","T10N_BROKEN"],"title":"TokenizationStatus","description":"Tokenization status."},"status_description":{"type":"string","title":"Status Description","description":"Tokenization status description for internal knowledge."},"status_message":{"type":"string","title":"Status Message","description":"Token description to be used as user message."},"context":{"$ref":"#/components/schemas/TokenCredentialContextSchema","description":"Credentials context."}},"type":"object","required":["token_id","date_created","date_expiration","status_code","context"],"title":"Token Credentials Status","description":"Response schema for token credentials containing both the token and its context.\nThe response includes:\n- A credential token containing the token ID and key\n- The context object with engine reference, app ID, customer ID, parameter ID, and features"},"TokenCredentialSchema":{"properties":{"token_id":{"type":"string","format":"ObjectId","title":"Token Id","examples":["644599da47847b79c03cc94f"]},"token_key":{"type":"string","maxLength":64,"minLength":64,"title":"Token Key"}},"type":"object","required":["token_id","token_key"],"title":"Credentials Token"},"TokenizedExecute":{"properties":{"external_execution_id":{"type":"string","maxLength":64,"minLength":1,"title":"External Execution Id","description":"External ID of the execution. \nUnique identifier for the execution in the client system, used to tracking and also \nenables the use of the same `customer_id`/`engine_reference` for multiple simultaneous \nexecutions.<br/>\n_**Note:** If not provided, then you can only have one execution per \n`customer_id`/`engine_reference` at the same time._"},"base_configurations":{"$ref":"#/components/schemas/BaseEngineConfigurationsSchema"},"features":{"items":{"oneOf":[{"$ref":"#/components/schemas/FeatureCustomerInformationReadRequest"},{"$ref":"#/components/schemas/FeatureContractsReadRequest"},{"$ref":"#/components/schemas/FeatureBankAccountsReadRequest"},{"$ref":"#/components/schemas/FeatureCreditsReadRequest"},{"$ref":"#/components/schemas/FeatureBankCardsReadRequest"},{"$ref":"#/components/schemas/FeatureBankDepositsReadRequest"},{"$ref":"#/components/schemas/FeatureBankLoansReadReadRequest"},{"$ref":"#/components/schemas/FeatureInvestmentAccountsReadRequest"},{"$ref":"#/components/schemas/FeatureBankFundsReadRequest"},{"$ref":"#/components/schemas/FeatureBankStocksReadRequest"},{"$ref":"#/components/schemas/FeaturePensionPlansReadRequest"},{"$ref":"#/components/schemas/FeatureDirectDebitsReadRequest"},{"$ref":"#/components/schemas/FeatureLaborCheckReadRequest"},{"$ref":"#/components/schemas/FeaturePublicPensionReadRequest"},{"$ref":"#/components/schemas/FeatureYearlyIndividualTaxRequest"},{"$ref":"#/components/schemas/FeatureVerifyPublicDocumentRequest"},{"$ref":"#/components/schemas/FeatureCitizenDataReadRequest"},{"$ref":"#/components/schemas/FeatureDriverDataReadRequest"},{"$ref":"#/components/schemas/FeaturePropertiesDataReadRequest"},{"$ref":"#/components/schemas/FeatureAcademicDataReadRequest"},{"$ref":"#/components/schemas/FeatureSupplierInvoicesReadRequest"},{"$ref":"#/components/schemas/FeatureClientInvoicesReadRequest"}],"discriminator":{"propertyName":"code","mapping":{"academic_data":"#/components/schemas/FeatureAcademicDataReadRequest","accounts_read":"#/components/schemas/FeatureBankAccountsReadRequest","cards_read":"#/components/schemas/FeatureBankCardsReadRequest","citizen_data":"#/components/schemas/FeatureCitizenDataReadRequest","client_invoices_read":"#/components/schemas/FeatureClientInvoicesReadRequest","credits_read":"#/components/schemas/FeatureCreditsReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","deposits_read":"#/components/schemas/FeatureBankDepositsReadRequest","direct_debits_read":"#/components/schemas/FeatureDirectDebitsReadRequest","driver_data":"#/components/schemas/FeatureDriverDataReadRequest","funds_read":"#/components/schemas/FeatureBankFundsReadRequest","investment_accounts_read":"#/components/schemas/FeatureInvestmentAccountsReadRequest","labor_check":"#/components/schemas/FeatureLaborCheckReadRequest","loans_read":"#/components/schemas/FeatureBankLoansReadReadRequest","pensions_read":"#/components/schemas/FeaturePensionPlansReadRequest","properties_data":"#/components/schemas/FeaturePropertiesDataReadRequest","public_document_verification":"#/components/schemas/FeatureVerifyPublicDocumentRequest","public_pensions":"#/components/schemas/FeaturePublicPensionReadRequest","source_contracts_read":"#/components/schemas/FeatureContractsReadRequest","stocks_read":"#/components/schemas/FeatureBankStocksReadRequest","supplier_invoices_read":"#/components/schemas/FeatureSupplierInvoicesReadRequest","yearly_individual_tax":"#/components/schemas/FeatureYearlyIndividualTaxRequest"}}},"type":"array","title":"Features","description":"Features to be executed by the engine, with each feature containing its own configurations."},"configurations":{"additionalProperties":true,"type":"object","title":"Configurations","description":"Particular engine configurations for the target engine if any. These configurations can be found in the \ntarget engine specification.</br>\nExample: `{'use_case': 'normal_execution', 'expected_password': '12345678'}`"},"hooks_extra_data":{"$ref":"#/components/schemas/ExecutionHooksExtraDataType","default":{}},"token":{"$ref":"#/components/schemas/TokenCredentialSchema","description":"Token credentials data"}},"additionalProperties":false,"type":"object","required":["token"],"title":"Tokenized Execution Request","description":"Payload for requesting an execution from previously stored tokenized access."},"TotalsEstimation":{"properties":{"gross_annual":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total estimated annual gross income"},"net_monthly":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total estimated net monthly income"},"annual_withholding":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total annual IRPF withholding"},"annual_worker_ss":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total annual worker Social Security"}},"type":"object","required":["gross_annual","net_monthly","annual_withholding","annual_worker_ss"],"title":"TotalsEstimation"},"U3XAccountRelation":{"properties":{"id":{"type":"string","title":"Id","description":"Linked customer IBAN number."},"participation":{"type":"string","title":"Participation","description":"Ownership of the customer in the account."},"participant_standard":{"type":"string","enum":["HOLDER","OTHER"],"title":"Participant Standard","description":"UX3 Participant standard."}},"type":"object","required":["id","participation","participant_standard"],"title":"[U3X] Customer/Account Relation"},"U3XBankAccount":{"properties":{"_id":{"type":"string","title":"Id","description":"Account ID / IBAN / Account number"},"customers":{"items":{"type":"string"},"type":"array","title":"Customers","description":"Array with customers document number."},"companies":{"items":{"$ref":"#/components/schemas/U3XCompany"},"type":"array","title":"Companies","description":"The name and CIF of the company/s associated with the read account are recovered.*Only available in business accounts.*"},"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***"}],"title":"Currency","description":"Currency of the account."},"last_update":{"type":"string","format":"datetime","title":"Last Update","description":"Last update date.","examples":["2023-10-05T14:46:36.546596Z"]},"bank_id":{"type":"string","title":"Bank Id","description":"Bank/Entity code"},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name"},"bank_group_id":{"type":"string","title":"Bank Group Id","description":"Bank group id \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance","description":"Account balance. Amount in cents."},"name":{"type":"string","title":"Name","description":"Account name"},"creation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Creation Date","description":"Account Opening date (if available)"}},"type":"object","required":["_id","customers","companies","currency","last_update","bank_id","bank_name","balance","name"],"title":"[U3X-ACC] - Bank Account","description":"Conversion to the U3X Bank Data Model in https://developer.unnax.com/docs/aggregation/adgn536x88k1i-bank-data-model"},"U3XBankAccountStatement":{"properties":{"_id":{"type":"string","title":"Id","description":"Statement ID"},"account":{"type":"string","title":"Account","description":"Account ID / IBAN / Account number"},"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***"}],"title":"Currency","description":"Currency of the statement."},"amount":{"type":"integer","title":"Amount","description":"Statement amount in cents."},"balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance","description":"Statement balance amount in cents."},"bank_reference":{"type":"string","title":"Bank Reference","description":"Statement bank reference."},"beneficiary":{"type":"string","title":"Beneficiary","description":"Statement beneficiary name."},"category":{"anyOf":[{"$ref":"#/components/schemas/U3XStatementCategory"},{"type":"null"}],"description":"Statement category. \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"concepts":{"items":{"type":"string"},"type":"array","title":"Concepts","description":"Array of statement concepts found."},"deposit_date":{"type":"string","format":"date","title":"Deposit Date","description":"Deposit date."},"value_date":{"type":"string","format":"date","title":"Value Date","description":"Value date."},"import_date":{"type":"string","format":"datetime","title":"Import Date","description":"Import date.","examples":["2023-10-05T14:46:36.546596Z"]},"bank_id":{"type":"string","title":"Bank Id","description":"Bank/Entity code"},"bank_group_id":{"type":"string","title":"Bank Group Id","description":"Bank group id \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"office":{"type":"string","title":"Office","description":"Bank office number."}},"type":"object","required":["_id","account","currency","concepts","deposit_date","value_date","import_date","bank_id","office"],"title":"[U3X-ACC] - Bank Account"},"U3XBankCard":{"properties":{"_id":{"type":"string","title":"Id","description":"Card ID."},"contract_number":{"type":"null","title":"Contract Number","description":"Contract number \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account","description":"Account linked to the card"},"creation_date":{"type":"null","title":"Creation Date","description":"Creation date \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"bank_id":{"type":"string","title":"Bank Id","description":"Bank/Entity code"},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name"},"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***"}],"title":"Currency","description":"Currency of the card."},"credit_available":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Available","description":"Available credit. Amount in cents."},"credit_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Limit","description":"Credit limit. Amount in cents."},"credit_disposed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Disposed","description":"Credit disposed. Amount in cents."},"last_update":{"type":"string","format":"datetime","title":"Last Update","description":"Last update date.","examples":["2023-10-05T14:46:36.546596Z"]},"expiration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Expiration Date","description":"Card expiration date."},"name":{"type":"string","title":"Name","description":"Card name"},"network":{"type":"string","title":"Network","description":"Card network"},"partial_card_number":{"type":"string","title":"Partial Card Number","description":"Partial card number"},"type":{"type":"integer","enum":[0,1,2],"title":"Type","description":"Card type. debit = 0 credit = 1 charge = 2 (prepaid card)"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Card active"},"customers":{"items":{"$ref":"#/components/schemas/U3XProductCustomer"},"type":"array","title":"Customers","description":"Card customers"}},"type":"object","required":["_id","bank_id","bank_name","currency","credit_available","credit_limit","credit_disposed","last_update","name","network","type","customers"],"title":"[U3X-CRD] - Bank Card","description":"Conversion to the U3X Bank Data Model in https://developer.unnax.com/docs/aggregation/adgn536x88k1i-bank-data-model"},"U3XBankCustomer":{"properties":{"_id":{"type":"string","title":"Id","description":"Customer id."},"names":{"type":"string","title":"Names","description":"Customer full name."},"document":{"type":"string","title":"Document","description":"Customer document id."},"birth_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birth Date","description":"Customer birth date."},"phones":{"items":{"type":"string"},"type":"array","title":"Phones","description":"Customer phones."},"emails":{"items":{"type":"string"},"type":"array","title":"Emails","description":"Customer emails."},"address":{"items":{"type":"string"},"type":"array","title":"Address","description":"Customer addresses."},"accounts_obj":{"items":{"$ref":"#/components/schemas/U3XAccountRelation"},"type":"array","title":"Accounts Obj"},"products_obj":{"items":{"$ref":"#/components/schemas/U3XProductRelation"},"type":"array","title":"Products Obj"},"logged_user":{"type":"boolean","title":"Logged User","description":"Is the customer the owner of the used bank credentials?","default":false}},"type":"object","required":["_id","names","document","phones","emails","address","accounts_obj","products_obj"],"title":"[U3X-HLD] - Bank Customer"},"U3XBankDataModelSchema":{"properties":{"request_code":{"type":"string","title":"Request Code","description":"INFONITE Execution ID"},"customers":{"items":{"$ref":"#/components/schemas/U3XBankCustomer"},"type":"array","title":"Customers","description":"Customers information."},"accounts":{"items":{"$ref":"#/components/schemas/U3XBankAccount"},"type":"array","title":"Accounts","description":"Accounts information."},"statements":{"items":{"$ref":"#/components/schemas/U3XBankAccountStatement"},"type":"array","title":"Statements","description":"Account statements."},"companies":{"items":{"$ref":"#/components/schemas/U3XCompany"},"type":"array","title":"Companies","description":"The name and CIF of the company/s associated with the read account are recovered.*Only available in business accounts.*"},"cards":{"items":{"$ref":"#/components/schemas/U3XBankCard"},"type":"array","title":"Cards","description":"Cards information."},"card_statements":{"items":{"$ref":"#/components/schemas/U3XCardStatement"},"type":"array","title":"Card Statements","description":"Card statements."},"loans":{"items":{"$ref":"#/components/schemas/U3XBankLoan"},"type":"array","title":"Loans","description":"Loans information."},"summary":{"$ref":"#/components/schemas/U3XFinancialSummary","description":"Summary of the aggregation information."},"loan_statements":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":0,"title":"Loan Statements","description":"\n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"insurances":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":0,"title":"Insurances","description":"\n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"insurance_statements":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":0,"title":"Insurance Statements","description":"\n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"pensions":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":0,"title":"Pensions","description":"\n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"pension_statements":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":0,"title":"Pension Statements","description":"\n> This field is maintained solely for backwards compatibility with legacy U3X systems."}},"type":"object","required":["customers","accounts","statements","companies","cards","card_statements","loans","summary","loan_statements","insurances","insurance_statements","pensions","pension_statements"],"title":"[U3X-BDM] - Bank Data Model","description":"Conversion to the U3X Bank Data Model"},"U3XBankLoan":{"properties":{"_id":{"type":"string","title":"Id","description":"Loan ID."},"loan_number":{"type":"string","title":"Loan Number","description":"Loan number"},"type":{"type":"integer","enum":[0,1],"title":"Type","description":"Interest type. 0=personal_loan 1=mortgage"},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account","description":"Account linked to the loan"},"name":{"type":"string","title":"Name","description":"Loan name"},"last_update":{"type":"string","format":"datetime","title":"Last Update","description":"Last update date.","examples":["2023-10-05T14:46:36.546596Z"]},"bank_id":{"type":"string","title":"Bank Id","description":"Bank/Entity code"},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name"},"creation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Creation Date","description":"Loan Begin Date"},"current_expiration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Current Expiration Date","description":"Current expiration date."},"initial_expiration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Initial Expiration Date","description":"Initial expiration date."},"next_receipt_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Next Receipt Date","description":"Next receipt date"},"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***"}],"title":"Currency","description":"Currency of the loan."},"initial_capital":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Initial Capital","description":"Granted amount. Amount in cents."},"outstanding_capital":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Outstanding Capital","description":"Outstanding capital in cents."},"next_receipt_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Receipt Amount","description":"Next receipt amount in cents."},"interest_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest Description","description":"Interest description."},"interest":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest","description":"Interest rate, percentile value."},"interest_type":{"anyOf":[{"type":"integer","enum":[0,1]},{"type":"null"}],"title":"Interest Type","description":"Interest type. 0=fixed 1=variable"},"pending_amortization_periods":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pending Amortization Periods","description":"Pending amortization periods"},"pending_grace_periods":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pending Grace Periods","description":"Number of pending grace periods."},"period":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period","description":"Loan Period."},"customers":{"items":{"$ref":"#/components/schemas/U3XProductCustomer"},"type":"array","title":"Customers","description":"Card customers"}},"type":"object","required":["_id","type","name","last_update","bank_id","bank_name","currency","initial_capital","outstanding_capital","next_receipt_amount","customers"],"title":"[U3X-LON] - Bank Loan"},"U3XCardStatement":{"properties":{"_id":{"type":"string","title":"Id","description":"Statement ID"},"card_id":{"type":"string","title":"Card Id","description":"U3X ID for the customer card."},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount","description":"Statement amount in cents."},"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***"}],"title":"Currency","description":"Currency of the statement."},"category":{"anyOf":[{"$ref":"#/components/schemas/U3XStatementCategory"},{"type":"null"}],"description":"Statement category. \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"concepts":{"items":{"type":"string"},"type":"array","title":"Concepts","description":"Array of statement concepts found."},"deposit_date":{"type":"string","format":"date","title":"Deposit Date","description":"Deposit date."},"partial_card_number":{"type":"string","title":"Partial Card Number","description":"Partial card number"},"value_date":{"type":"string","format":"date","title":"Value Date","description":"Value date."},"settlement":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Settlement","description":"Cards statement settlement done. \n> This field is maintained solely for backwards compatibility with legacy U3X systems."},"bank_id":{"type":"string","title":"Bank Id","description":"Bank/Entity code"}},"type":"object","required":["_id","card_id","currency","concepts","deposit_date","value_date","bank_id"],"title":"[U3X-CRD] - Card Statements"},"U3XCompany":{"properties":{"name":{"type":"string","title":"Name"},"cif":{"type":"string","title":"Cif"}},"type":"object","title":"U3XCompany"},"U3XFinancialSummary":{"properties":{"all_accounts":{"additionalProperties":true,"type":"object","title":"All Accounts","description":"Summary all accounts together."},"by_bank":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"By Bank","description":"Summary by bank."},"by_account":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"By Account","description":"Summary by account."}},"type":"object","required":["all_accounts","by_bank","by_account"],"title":"[U3X-SUM] - Financial Summary"},"U3XHStatementCategory":{"properties":{"id":{"type":"integer","title":"Id"},"title":{"type":"string","title":"Title"}},"type":"object","required":["id","title"],"title":"U3XHStatementCategory"},"U3XProductCustomer":{"properties":{"_id":{"type":"string","title":"Id","description":"Customer id."},"names":{"type":"string","title":"Names","description":"Customer full name."},"address":{"items":{"type":"string"},"type":"array","title":"Address","description":"Customer addresses."},"birth_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birth Date","description":"Customer birth date."},"phones":{"items":{"type":"string"},"type":"array","title":"Phones","description":"Customer phones."},"emails":{"items":{"type":"string"},"type":"array","title":"Emails","description":"Customer emails."}},"type":"object","required":["_id","names","address","phones","emails"],"title":"[U3X-HLD] - Card Customer"},"U3XProductRelation":{"properties":{"id":{"type":"string","title":"Id","description":"Linked customer IBAN number."},"participation":{"type":"string","title":"Participation","description":"Ownership of the customer in the product."},"participant_standard":{"type":"string","enum":["HOLDER","OTHER"],"title":"Participant Standard","description":"UX3 Participant standard."},"type":{"type":"string","enum":["account","card","loan"],"title":"Type","description":"Product type."}},"type":"object","required":["id","participation","participant_standard","type"],"title":"[U3X] Customer/Product Relation"},"U3XStatementCategory":{"properties":{"id":{"type":"integer","title":"Id"},"title":{"type":"string","title":"Title"},"hierarchy":{"anyOf":[{"$ref":"#/components/schemas/U3XHStatementCategory"},{"type":"null"}]}},"type":"object","required":["id","title"],"title":"U3XStatementCategory"},"Update":{"properties":{"event":{"type":"string","enum":["started","action_required","ended","auth_ended"],"title":"ExecutionEventType","description":"Event to trigger the hook"},"producer":{"anyOf":[{"type":"string","const":"Root","title":"Root"},{"type":"string","enum":["accounts_read","cards_read","deposits_read","loans_read","credits_read","investment_accounts_read","funds_read","stocks_read","pensions_read","accounts_certificates","direct_debits_read","customer_information_read","source_contracts_read","cloud_resource_read","supplier_invoices_read","client_invoices_read","labor_check","public_pensions","public_document_verification","yearly_individual_tax","citizen_data","driver_data","academic_data","properties_data"],"title":"FeatureType","description":"Features allowed by an engine\nAllowed values are:\n - `accounts_read`: Financial Accounts Read\n- `cards_read`: Financial Cards Read\n- `deposits_read`: Financial Deposits Read\n- `loans_read`: Financial Loans Read\n- `credits_read`: Financial Credits Read\n- `investment_accounts_read`: Investment Accounts Read\n- `funds_read`: Investment Funds Read\n- `stocks_read`: Investment Stocks Read\n- `pensions_read`: Pension Plans Read\n- `accounts_certificates`: Account Certificates Read\n- `direct_debits_read`: Direct Debits Read\n- `customer_information_read`: Customer Information Read\n- `source_contracts_read`: Source Contracts Read\n- `cloud_resource_read`: Cloud Provider Resource Read\n- `supplier_invoices_read`: Supplier Invoices Read\n- `client_invoices_read`: Client Invoices Read\n- `labor_check`: Labor Check\n- `public_pensions`: Public Pensions\n- `public_document_verification`: Public Document Verification\n- `yearly_individual_tax`: Yearly Taxes for Individuals\n- `citizen_data`: Public Citizen Data\n- `driver_data`: Driver & Vehicles Data\n- `academic_data`: Academic Data\n- `properties_data`: Properties Data"}],"title":"Producer","description":"Use `Root` to suscribe to events produced by general execution, such as the beginning and the end of the execution. *You can also use a `FeatureType` to subscribe to events produced by an specific feature*"},"enabled":{"type":"boolean","title":"Enabled","description":"Indicates if the hook is enabled","default":false},"method":{"type":"string","enum":["POST","PUT"],"title":"CallbackHttpMethod","description":"HTTP method to use"},"base_url":{"type":"string","title":"Base Url","description":"Base URL to send the request to. Dynamic query parameters can be added later."}},"additionalProperties":false,"type":"object","required":["event","producer","method","base_url"],"title":"Update Client App Hook Config"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string","description":"Key of an item in payloads objects","examples":["some_key"]},{"type":"integer","description":"Index if an item in payloads arrays","examples":["some_key"]}]},"type":"array","title":"Error location","description":"Location of the error","examples":[["body","some_array",0]]},"msg":{"type":"string","title":"Msg","description":"Detailed error message","examples":["ensure this value has at least 8 characters"]},"type":{"type":"string","title":"Type","description":"Error type","examples":["value_error.any_str.min_length"]},"input":{"title":"Input","description":"Input value","examples":["some_value"]},"ctx":{"additionalProperties":true,"type":"object","title":"Error Context","description":"Context","examples":[{"limit_value":8}]}},"type":"object","required":["loc","msg","type"],"title":"Validation Error Item","description":"Object representing a validation error"},"ValidationErrorResponse":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","required":["detail"],"title":"Validation Error Response","description":"Gives details about the validation errors for the given payload"},"VehicleInsuranceSchema":{"properties":{"is_active":{"type":"boolean","title":"Is Active","description":"Whether the vehicle has an active insurance policy."},"company":{"type":"string","title":"Company","description":"Name of the insurance company."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Start date of the insurance policy."},"end_date":{"type":"string","format":"date","title":"End Date","description":"End date of the insurance policy."}},"type":"object","required":["is_active"],"title":"Vehicle Insurance"},"WorkRelationSchema":{"properties":{"activity_start":{"type":"string","format":"date","title":"Activity Start","description":"Activity start date"},"activity_end":{"type":"string","format":"date","title":"Activity End","description":"Activity end date"},"name":{"type":"string","title":"Name","description":"Company or Relation name"},"regime":{"type":"string","title":"Regime","description":"Régime"},"work_type":{"type":"string","enum":["unknown","employee","self_employed","public_employee","vacations","unemployment_benefits","other"],"title":"WorkType","description":"Work type"},"contract_type":{"type":"string","enum":["unknown","permanent","temporary","training","professional_practices","fixed_discontinuous"],"title":"WorkContractType","description":"Contract type"},"work_schedule":{"type":"string","enum":["unknown","full_time","part_time"],"title":"WorkScheduleType","description":"Work schedule"},"contribution_group":{"type":"string","title":"Contribution Group","description":"Contribution group"},"collective_agreement":{"type":"string","title":"Collective Agreement","description":"Collective agreement"},"social_security_days":{"type":"integer","title":"Social Security Days","description":"Social security days"}},"type":"object","required":["activity_start","name","work_type","contract_type","work_schedule"],"title":"Company Relation"},"XMeta":{"properties":{"instructions_title":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Title","description":"Title of the form"},"instructions_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Text","description":"Title of the form"},"submit_button_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Submit Button Text","description":"Title of the form"},"reason":{"type":"string","const":"MFA_REQUIRED","title":"Reason"},"timeout":{"type":"integer","title":"Timeout","description":"Timeout in seconds"},"mfa_type":{"type":"string","enum":["otp-sms","otp-email","push-notification","totp","generic"],"title":"MFAType","description":"Type of MFA"}},"additionalProperties":true,"type":"object","required":["reason","timeout","mfa_type"],"title":"MFA Required Form Meta Information","description":"Meta-information of the MFA required form"},"YearlyPersonalTaxSituationSchema":{"properties":{"product":{"type":"string","const":"tax_information","title":"Product"},"sub_family":{"type":"string","const":"tax_information:persons_yearly_fiscal_data","title":"Sub Family"},"fetch_date":{"type":"string","format":"datetime","title":"Fetch Date","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"primary_taxpayer":{"type":"string","title":"Primary Taxpayer","description":"National identifier of the taxpayer","examples":["X0069750Z"]},"joint_taxpayers":{"items":{"type":"string"},"type":"array","title":"Joint Taxpayers","description":"List of national identifiers for joint taxpayers"},"address":{"$ref":"#/components/schemas/AddressSchema","description":"Fiscal address for the exercise"},"address_reference":{"type":"string","title":"Address Reference","description":"Cadastral reference for the main home"},"country_code":{"type":"string","format":"country","title":"Country Code","description":"Country code for the tax declaration","examples":["ES","US"]},"currency":{"type":"string","format":"currency","title":"Currency","description":"Currency for the tax declaration","examples":["EUR","USD","GBP"]},"tax_agency":{"type":"string","title":"Tax Agency","description":"Tax agency for the tax declaration"},"fiscal_year_start":{"type":"string","format":"date","title":"Fiscal Year Start","description":"Start date of the fiscal year"},"fiscal_year_end":{"type":"string","format":"date","title":"Fiscal Year End","description":"End date of the fiscal year"},"status":{"type":"string","enum":["unknown","data","draft","submitted","not_required","amended"],"title":"FiscalDataStatus","description":"Status of the fiscal data"},"filing_category":{"type":"string","enum":["individual","joint"],"title":"Filing Category","description":"Category of the tax filing"},"taxable_base":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total taxable base"},"total_tax_paid":{"$ref":"#/components/schemas/CurrencyAmount","description":"Total tax paid or withheld"},"final_tax_result":{"$ref":"#/components/schemas/CurrencyAmount","description":"Final tax result (to be paid or refunded)"},"income":{"$ref":"#/components/schemas/IncomeDetails","description":"Detailed breakdown of income"},"deductions":{"$ref":"#/components/schemas/DeductionDetails","description":"Detailed breakdown of deductions"},"liabilities":{"$ref":"#/components/schemas/LiabilityDetails","description":"Detailed breakdown of liabilities"},"attachments":{"items":{"$ref":"#/components/schemas/FileAttachmentSchema"},"type":"array","title":"Attachments","description":"List of attached supporting documents","default":[]}},"type":"object","required":["product","sub_family","fetch_date","primary_taxpayer","address","address_reference","country_code","currency","tax_agency","fiscal_year_start","fiscal_year_end","status","filing_category","taxable_base","total_tax_paid","final_tax_result","income","deductions","liabilities"],"title":"Yearly Fiscal Data / Persons"},"catgrid_core__pydantic__fields__common__Rate__2":{"properties":{"value":{"type":"string","format":"number","title":"Value","description":"Decimal number with 6 digits precision","default":"NaN","examples":["1.000000","NaN"]},"unit":{"anyOf":[{"type":"string","const":"%","title":"%","description":"Rate in percentage"},{"type":"string","format":"currency","examples":["EUR","USD","GBP"]}],"title":"Unit","default":"%"},"description":{"anyOf":[{"type":"string","description":"Description of the rate"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Description"}},"type":"object","title":"Rate"},"catgrid_core__schemas__ui__field_group__FieldsGroupSchema__XMeta":{"properties":{"instructions_title":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Title","description":"Title of the form"},"instructions_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Text","description":"Title of the form"},"submit_button_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Submit Button Text","description":"Title of the form"}},"additionalProperties":true,"type":"object","title":"Form Meta Information","description":"Meta-information of the form"},"catgrid_core__schemas__ui__field_group__InputRequiredFieldsGroupSchema__XMeta":{"properties":{"instructions_title":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Title","description":"Title of the form"},"instructions_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Text","description":"Title of the form"},"submit_button_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Submit Button Text","description":"Title of the form"},"reason":{"type":"string","const":"INPUT_REQUIRED","title":"Reason"},"timeout":{"type":"integer","title":"Timeout","description":"Timeout in seconds"}},"additionalProperties":true,"type":"object","required":["reason","timeout"],"title":"MFA Required Form Meta Information","description":"Meta-information of the MFA required form"},"catgrid_core__schemas__ui__field_group__ParametersFieldsGroupSchema__XMeta":{"properties":{"instructions_title":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Title","description":"Title of the form"},"instructions_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Instructions Text","description":"Title of the form"},"submit_button_text":{"anyOf":[{"type":"string"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Submit Button Text","description":"Title of the form"},"locking_fields":{"items":{"type":"string"},"type":"array","title":"Locking Fields","description":"List of properties from parameters that does not change in an user for the engine. For example, in a standard login form, the username is a locking field. ","examples":[["username"]]},"hidden_fields":{"items":{"type":"string"},"type":"array","title":"Hidden Fields","description":"List of properties to be hidden in the form. ","examples":[["hidden"]]},"lazy_fields":{"items":{"type":"string"},"type":"array","title":"Lazy Fields","description":"List of properties to be lazy loaded in the form, meaning that the value will be prompted to the user latter if required. ","examples":[["dynamic_field"]]}},"additionalProperties":true,"type":"object","title":"Form Meta Information","description":"Meta-information of the parameters form"},"catgrid_core__schemas__utils__CurrencyAmountSchema__1":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***","title":"***","description":"Unknown currency","examples":["***"]}],"title":"Currency"},"amount":{"type":"string","format":"number","title":"Amount","description":"Decimal number with 2 digits precision","examples":["1.00","NaN"]}},"type":"object","required":["currency","amount"],"title":"Currency Amount","description":"Model representing a currency amount"},"catgrid_core__schemas__utils__CurrencyAmountSchema__2":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***","title":"***","description":"Unknown currency","examples":["***"]}],"title":"Currency"},"amount":{"type":"string","format":"number","title":"Amount","description":"Decimal number with 6 digits precision","default":"nan","examples":["1.000000","NaN"]}},"type":"object","required":["currency"],"title":"Currency Amount"},"catgrid_core__schemas__utils__CurrencyAmountSchema__3":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","examples":["EUR","USD","GBP"]},{"type":"string","const":"***","title":"***","description":"Unknown currency","examples":["***"]}],"title":"Currency"},"amount":{"type":"string","format":"number","title":"Amount","description":"Decimal number with 6 digits precision","default":"nan","examples":["1.000000","NaN"]}},"type":"object","required":["currency"],"title":"Currency Amount"},"catgrid_forms__engines__features__financial__accounts__FeatureConfigurations":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","description":"The date from which the sub-product will be read","default":"30 days ago","examples":["2023-04-12"]},"to_date":{"type":"string","format":"date","title":"To Date","description":"The date until which the sub-product will be read","default":"today","examples":["2023-04-12"]},"limits_behaviour":{"type":"string","enum":["error","adapt"],"title":"Limits Behaviour","description":"The behaviour when the date limits are not respected.\n- `error`: raise an error and abort the execution\n- `adapt`: adapt the dates to the limits and continue the execution","default":"error"},"read_transactions":{"type":"boolean","title":"Read Transactions","description":"If true, the engine will try to read the account transactions","default":false},"read_holders":{"type":"boolean","title":"Read Holders","description":"If true, the engine will try to read the account holders","default":false}},"type":"object","title":"Accounts Read Configurations"},"catgrid_forms__engines__features__financial__cards__FeatureConfigurations":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","description":"The date from which the sub-product will be read","default":"30 days ago","examples":["2023-04-12"]},"to_date":{"type":"string","format":"date","title":"To Date","description":"The date until which the sub-product will be read","default":"today","examples":["2023-04-12"]},"limits_behaviour":{"type":"string","enum":["error","adapt"],"title":"Limits Behaviour","description":"The behaviour when the date limits are not respected.\n- `error`: raise an error and abort the execution\n- `adapt`: adapt the dates to the limits and continue the execution","default":"error"},"read_transactions":{"type":"boolean","title":"Read Transactions","description":"If true, the engine will try to read the card transactions","default":false},"filter_by_type":{"items":{"type":"string","enum":["financial_card:debit","financial_card:credit","financial_card:prepaid","financial_card:mixed"],"title":"FinancialCardType","description":"Financial Card Type\nAllowed values are:\n - `financial_card:debit`: Debit Card\n- `financial_card:credit`: Credit Card\n- `financial_card:prepaid`: Prepaid Card\n- `financial_card:mixed`: Mixed Card"},"type":"array","minItems":1,"title":"Filter By Type","description":"The types of cards to be read. By default all types are requested","default":["financial_card:credit","financial_card:mixed","financial_card:debit","financial_card:prepaid"]}},"type":"object","title":"Cards Read Configurations"},"catgrid_forms__engines__features__public__academic_data__FeatureConfigurations":{"properties":{},"type":"object","title":"Academic Data Configurations"},"catgrid_forms__engines__features__public__citizen_data__FeatureConfigurations":{"properties":{},"type":"object","title":"Citizen Data Configurations"},"catgrid_forms__engines__features__public__driver_data__FeatureConfigurations":{"properties":{},"type":"object","title":"Driver Data Configurations"},"catgrid_forms__engines__features__public__labor_check__FeatureConfigurations":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date","description":"The date from which the contribution history will be retrieved","default":"12 months ago","examples":["2023-04-12"]}},"type":"object","title":"Labor Check Configurations"},"catgrid_forms__engines__features__public__properties_data__FeatureConfigurations":{"properties":{},"type":"object","title":"Properties Data Configurations"},"catgrid_forms__engines__features__public__yearly_individual_tax__FeatureConfigurations":{"properties":{"last_n_years":{"type":"integer","maximum":5.0,"minimum":1.0,"title":"Last N Years","description":"Last n years to retrieve the tax data.","default":3}},"type":"object","title":"Yearly Individual Tax Configurations"}},"securitySchemes":{"Application-Secret":{"type":"apiKey","description":"Application Secret","in":"header","name":"X-APP-SECRET"}}},"tags":[{"name":"Engines Marketplace","description":"Engines Marketplace"},{"name":"Execution Handling","description":"Dealing with executions"},{"name":"Tokenization Handling","description":"Dealing with tokenization"},{"name":"Customer Profile Data","description":"Customer Profile Data"},{"name":"Financial Data","description":"Financial Data"},{"name":"Commercial Data","description":"Commercial Data"},{"name":"Public Administration Data","description":"Public Administration Data"},{"name":"Cloud Provider Data","description":"Cloud Providers Data"},{"name":"Execution Attachments","description":"Execution Attachments"},{"name":"Other Data","description":"Other Data"},{"name":"[CONFIG] Webhooks","description":"[CONFIG] Webhooks"}]}