{"openapi":"3.1.0","info":{"title":"Widgets Service","description":"Widgets 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.4.800"},"servers":[{"url":"https://widgets.infonite.tech/","description":"Widgets Service Server"}],"paths":{"/api/flows/bank_reader/v1/manager/init":{"post":{"tags":["[Flows] Bank Reader"],"summary":"1.1 Init Session (Manager)","description":"Creates a new Bank Reader Flow. <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_create_api_flows_bank_reader_v1_manager_init_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create"}}},"required":true},"responses":{"200":{"description":"**200 OK**<br>Flow Session created successfully","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowStateSchema__Acceptance"}}}},"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"}}}},"409":{"description":"**409 Conflict**<br>Flow Session already exists","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/flows/bank_reader/v1/manager/{session_id}":{"get":{"tags":["[Flows] Bank Reader"],"summary":"1.2 Session State (Manager)","description":"Fetch the state of a given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_state_api_flows_bank_reader_v1_manager__session_id__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowStateSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/bank_reader/v1/manager/{session_id}/settings":{"get":{"tags":["[Flows] Bank Reader"],"summary":"1.3 Session Settings (Manager)","description":"Fetch the active settings of a given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_settings_api_flows_bank_reader_v1_manager__session_id__settings_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowSettingsSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/bank_reader/v1/manager/{session_id}/results":{"get":{"tags":["[Flows] Bank Reader"],"summary":"1.4 Session Results (Manager)","description":"Fetch the results of a given session. Only works for `COMPLETED` sessions <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_settings_api_flows_bank_reader_v1_manager__session_id__results_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowResultsSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"**404 Not Found**<br>Session still open or not completed","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/bank_reader/v1/manager/{session_id}/cancel":{"patch":{"tags":["[Flows] Bank Reader"],"summary":"1.5 Cancel (Manager)","description":"Cancel/Closes the given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_action_cancel_api_flows_bank_reader_v1_manager__session_id__cancel_patch","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"204":{"description":"**204 No Content**<br>Cancelled 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>Session already ended","headers":{}},"404":{"description":"**404 Not Found**<br>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/bank_reader/v1/manager/{session_id}/delete":{"delete":{"tags":["[Flows] Bank Reader"],"summary":"1.6 Delete Session (Manager)","description":"Delete a session and all its results <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"bank_reader_v1_manager_session_action_delete_api_flows_bank_reader_v1_manager__session_id__delete_delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session 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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>Session cannot be deleted","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/es_citizen_data/v1/manager/init":{"post":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.1 Init Session (Manager)","description":"Creates a new Citizen Data Reader Flow to access data from Public Administrations (e.g., labor, cadastre, and tax data). <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_create_api_flows_es_citizen_data_v1_manager_init_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowStateSchema__Create"}}},"required":true},"responses":{"200":{"description":"**200 OK**<br>Flow Session created successfully","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Acceptance"}}}},"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"}}}},"409":{"description":"**409 Conflict**<br>Flow Session already exists","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"Application-Secret":[]}]}},"/api/flows/es_citizen_data/v1/manager/{session_id}":{"get":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.2 Session State (Manager)","description":"Fetch the state of a given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_state_api_flows_es_citizen_data_v1_manager__session_id__get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowStateSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/es_citizen_data/v1/manager/{session_id}/settings":{"get":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.3 Session Settings (Manager)","description":"Fetch the active settings of a given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_settings_api_flows_es_citizen_data_v1_manager__session_id__settings_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowSettingsSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/es_citizen_data/v1/manager/{session_id}/results":{"get":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.4 Session Results (Manager)","description":"Fetch the results of a given session. Only works for `COMPLETED` sessions <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_settings_api_flows_es_citizen_data_v1_manager__session_id__results_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"200":{"description":"**200 OK**<br>State of the session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowResultsSchema"}}},"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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"**404 Not Found**<br>Session still open or not completed","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/es_citizen_data/v1/manager/{session_id}/cancel":{"patch":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.5 Session Cancel (Manager)","description":"Cancel/Closes the given session.  <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_action_cancel_api_flows_es_citizen_data_v1_manager__session_id__cancel_patch","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID to fetch"}],"responses":{"204":{"description":"**204 No Content**<br>Cancelled 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>Session already ended","headers":{}},"404":{"description":"**404 Not Found**<br>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/es_citizen_data/v1/manager/{session_id}/delete":{"delete":{"tags":["[Flows] Spain Citizen Data"],"summary":"1.6 Delete Session (Manager)","description":"Delete a session and all its results <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"es_citizen_data_v1_manager_session_action_delete_api_flows_es_citizen_data_v1_manager__session_id__delete_delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","description":"Session ID to fetch","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session 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>Session not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"**409 Conflict**<br>Session cannot be deleted","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"**504 Gateway Timeout**<br>Lock timeout, retry again","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/flows/attachments":{"get":{"tags":["[MISC] Attachments"],"summary":"Download attachment","description":"Downloads the specified attachment file. <br/>_**Note:** This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers._","operationId":"client_execution_results_attachments_download_api_flows_attachments_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"session_id","in":"query","required":true,"schema":{"type":"string","description":"Session ID where the attachment was retrieved.","format":"ObjectId","examples":["644599da47847b79c03cc94f"],"title":"Session Id"},"description":"Session ID where the attachment was retrieved."},{"name":"attachment_id","in":"query","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":{}},"412":{"description":"**412 Precondition Failed**<br>Session still open.","headers":{}}}}},"/api/app":{"get":{"summary":"Current Application","description":"Show the current app's information","operationId":"clients_applications_config_app_info_api_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"}}}}},"security":[{"Application-Secret":[]}]}},"/api/config/hooks/{flow_type}/list":{"get":{"tags":["[Config] Flow Webhooks"],"summary":"List Flow Hooks","description":"Flow Hooks are a way to trigger callbacks from your INFONITE widgets to a URL of your choice. This can be useful for integrating with third-party services or triggering actions in your own application.","operationId":"widgets_applications_config_hooks_list_api_config_hooks__flow_type__list_get","security":[{"Application-Secret":[]}],"parameters":[{"name":"flow_type","in":"path","required":true,"schema":{"enum":["bank_reader","es_citizen_data"],"type":"string","title":"Flow Type","description":"Type of experience\nAllowed values are:\n - `bank_reader`: Bank data read experience\n- `es_citizen_data`: Spain Citizen data read experience"},"description":"Flow type to fetch"},{"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/AnyWidgetHooksConfigSchema"},"title":"Response Widgets Applications Config Hooks List Api Config Hooks  Flow Type  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"}}}}}}},"/api/config/hooks/{flow_type}/update":{"patch":{"tags":["[Config] Flow Webhooks"],"summary":"Create/Update Flow Hook","description":"### Application Webhooks\n\nHooks are a way to trigger callbacks from your INFONITE flow 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 Flow Webhook\n\nYou should crate a webhook for each event you want to listen to. Available events are:\n\n- `bank_reader:started`: Raised when a bank reader widget is opened by the user.\n- `bank_reader:ended`: Raised when a bank reader execution has ended and is in a final state.\n- `es_citizen_data:started`: Raised when an ES Citizen Data widget is opened by the user.\n- `es_citizen_data:ended`: Raised when an ES Citizen Data execution has ended and is in a final state.\n\nAlso you should provide the URL, and the http method.\n\nFor example, to create a webhook triggered on execution Bank Reader Flow ends, you  should create a hook like this one:\n\n```json\n{\n    \"event\": \"bank_reader:ended\",\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  \"event_class\": \"BankReaderV1FlowEvent\",\n  \"app_id\": \"<your_app_id>\",\n  \"customer_id\": \"<customer_id>\",\n  \"session_id\": \"<session_id>\",\n  \"event\": \"bank_reader:ended\",\n  \"date\": \"2025-10-29T10:49:01+00:00\",\n  \"status_code\": \"<status_reason_at_the_moment_of_the_event>\",\n  \"status_message\": \"Flow has been completed\",\n  \"data\": \"<encrypted_data_from_the_execution>\"\n}\n```","operationId":"widgets_applications_config_hooks_patch_api_config_hooks__flow_type__update_patch","security":[{"Application-Secret":[]}],"parameters":[{"name":"flow_type","in":"path","required":true,"schema":{"enum":["bank_reader","es_citizen_data"],"type":"string","title":"Flow Type","description":"Type of experience\nAllowed values are:\n - `bank_reader`: Bank data read experience\n- `es_citizen_data`: Spain Citizen data read experience"},"description":"Flow type to fetch"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update"}}}},"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","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"}}}}}}},"/api/config/hooks/{flow_type}/delete":{"delete":{"tags":["[Config] Flow Webhooks"],"summary":"Delete Flow Hook","description":"Deletes the given flow hook","operationId":"widgets_applications_config_hooks_delete_api_config_hooks__flow_type__delete_delete","security":[{"Application-Secret":[]}],"parameters":[{"name":"flow_type","in":"path","required":true,"schema":{"enum":["bank_reader","es_citizen_data"],"type":"string","title":"Flow Type","description":"Type of experience\nAllowed values are:\n - `bank_reader`: Bank data read experience\n- `es_citizen_data`: Spain Citizen data read experience"},"description":"Flow type to fetch"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete"}}}},"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"}}}},"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"}}}}}}}},"components":{"schemas":{"AcademicFamily":{"properties":{"higher_education_degrees":{"items":{"$ref":"#/components/schemas/HigherEducationSchema"},"type":"array","title":"Higher Education Degrees","description":"Higher education degrees:"},"secondary_education":{"items":{"$ref":"#/components/schemas/SecondaryEducationSchema"},"type":"array","title":"Secondary Education","description":"Secondary education"}},"type":"object","title":"Academic Family"},"Acceptance":{"properties":{"session_id":{"type":"string","format":"ObjectId","title":"Session Id","description":"Session ID","examples":["644599da47847b79c03cc94f"]},"widget_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Widget Url","description":"Widget URL"},"session_token":{"type":"string","maxLength":20,"minLength":20,"format":"session-code","title":"Session Token","description":"Session token for the final customer","examples":["XXXXXXXXXXXXXXXXXXXX"]}},"type":"object","required":["session_id","widget_url","session_token"],"title":"Citizen Data v1 - Acceptance"},"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"},"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 <ISO 3166-1>","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"},"AnyWidgetHooksConfigSchema":{"properties":{"app_id":{"type":"string","format":"ObjectId","title":"App Id","description":"App ID","examples":["644599da47847b79c03cc94f"]},"producer":{"type":"string","enum":["bank_reader","es_citizen_data"],"title":"FlowType","description":"Flow who executes the hook"},"event":{"type":"string","title":"Event","description":"Event who 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":"Widget Hook Config"},"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"},"CitizenDataGlobalPositionSchema":{"properties":{"customer":{"$ref":"#/components/schemas/CustomerFamily","description":"Customer family"},"academic":{"$ref":"#/components/schemas/AcademicFamily","description":"Academic family"},"driver":{"$ref":"#/components/schemas/DriverFamily","description":"Driver & vehicles family"},"employment":{"$ref":"#/components/schemas/EmploymentFamily","description":"Employment family"},"tax":{"$ref":"#/components/schemas/TaxesFamily","description":"Tax family"},"properties":{"$ref":"#/components/schemas/PropertiesFamily","description":"Properties family"}},"type":"object","title":"Financial Global Position"},"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"},"ClientAppSchema":{"properties":{"id":{"type":"string","format":"ObjectId","title":"Id","description":"Company ID","examples":["644599da47847b79c03cc94f"]},"company_id":{"type":"string","format":"ObjectId","title":"Company Id","description":"Company ID","examples":["644599da47847b79c03cc94f"]},"display_name":{"type":"string","maxLength":100,"minLength":1,"title":"Display Name","description":"Display name of the Application. Used in the UI"},"internal_name":{"type":"string","maxLength":250,"minLength":1,"title":"Internal Name","description":"Internal name of the application"},"environment":{"type":"string","enum":["sandbox","production"],"title":"AppEnvironment","description":"Environment of the application"},"approved_at":{"anyOf":[{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","examples":["2023-10-05T14:46:36.546596Z"]},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Approved At"},"description":{"anyOf":[{"type":"string","description":"Description of the application"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Description"},"website":{"anyOf":[{"$ref":"#/components/schemas/ToString_HttpUrl_","description":"Website"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Website"},"contact_email":{"anyOf":[{"$ref":"#/components/schemas/ToString_EmailStr_","description":"Contact Email"},{"type":"null","title":"null","description":"No value. Allowed value: `null`"}],"title":"Contact Email"},"deleted_at":{"anyOf":[{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","examples":["2023-10-05T14:46:36.546596Z"]},{"type":"null"}],"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","description":"Information about lock status"},"is_locked":{"type":"boolean","title":"Is Locked","description":"Indicates if the app is locked","readOnly":true},"status":{"type":"string","enum":["pending","active","locked","archived"],"title":"AppStatus","description":"Application status","readOnly":true}},"type":"object","required":["id","company_id","display_name","environment","tags","lockable","is_locked","status"],"title":"Client Application Schema"},"ConsentOutput":{"properties":{"accepted_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the consent was accepted","examples":["2023-10-05T14:46:36.546596Z"]},"accepted_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":"Accepted Features","description":"Accepted features"},"user_ip":{"type":"string","title":"User Ip","description":"User IP"},"user_agent":{"type":"string","title":"User Agent","description":"User Agent"},"origin":{"type":"string","title":"Origin","description":"Origin"},"user_phone":{"type":"string","title":"User Phone","description":"User phone"},"user_email":{"type":"string","title":"User Email","description":"User email"},"user_full_name":{"type":"string","title":"User Full Name","description":"User full name"},"user_identification":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"User identification"}},"type":"object","required":["accepted_date","accepted_features"],"title":"Citizen Data v1 - Consent Output"},"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"},"Create":{"properties":{"customer_id":{"type":"string","maxLength":64,"minLength":1,"title":"Customer Id","description":"External ID of the customer. Refers to the end user.<br/>_**Note:** This ID is relevant for statistics and billing purposes._","examples":["test-customer-1234"]},"date_limit":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Maximum date and time when the session is usable by the customer. _If not provided, the session will be valid for 72 hours._","examples":["2023-10-05T14:46:36.546596Z"]},"settings":{"$ref":"#/components/schemas/catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowSettingsSchema__Create","description":"Session Settings"}},"additionalProperties":false,"type":"object","required":["customer_id","settings"],"title":"Bank Reader v1 - Create Session"},"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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","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","title":"Currency <ISO 4217>","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":"DateTime <UTC Localized>","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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","description":"Country of birth","examples":["ES","US"]},"nationality_country":{"type":"string","format":"country","title":"Country <ISO 3166-1>","description":"Country of nationality","examples":["ES","US"]},"residence_country":{"type":"string","format":"country","title":"Country <ISO 3166-1>","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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","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","title":"Event","description":"Event to match the deletion"}},"additionalProperties":false,"type":"object","required":["event"],"title":"Delete Flow Hook Config"},"DirectDebitTransactionSchema":{"properties":{"status":{"type":"string","enum":["unknown","pending","booked","cancelled","failed","reversed"],"title":"FinancialTransactionStatus","description":"Transaction status"},"issue_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Transaction issue date","examples":["2023-10-05T14:46:36.546596Z"]},"payment_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","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"},"DriverFamily":{"properties":{"data":{"$ref":"#/components/schemas/EUDriverDataSchema","description":"Driver data"},"vehicles":{"items":{"$ref":"#/components/schemas/EUOwnedVehicleSchema"},"type":"array","title":"Vehicles","description":"Officially owned vehicles"}},"type":"object","title":"Driver & Vehicles Family"},"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":"DateTime <UTC Localized>","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country <ISO 3166-1>","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":"DateTime <UTC Localized>","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country <ISO 3166-1>","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":"DateTime <UTC Localized>","description":"Date this product was fetched","examples":["2023-10-05T14:46:36.546596Z"]},"country":{"type":"string","format":"country","title":"Country <ISO 3166-1>","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"},"EmploymentFamily":{"properties":{"labor_check":{"$ref":"#/components/schemas/TGSSSpainLaborCheckSchema","description":"Labor check"},"pensions":{"items":{"$ref":"#/components/schemas/TGSSSpainPublicPensionSchema"},"type":"array","title":"Pensions","description":"Public Pensions"}},"type":"object","title":"Employment Family"},"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"},"EntitySchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name"},"code":{"type":"string","title":"Code","description":"Code"},"country_code":{"type":"string","format":"country","title":"Country <ISO 3166-1>","description":"Country Code","examples":["ES","US"]},"identifier":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"Holder identifier"}},"type":"object","title":"Entity"},"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"},"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/FeatureConfigurations"}},"additionalProperties":false,"type":"object","required":["code"],"title":"Public Citizen Data","description":"Feature that retrieves the citizen data from public administrations aggregated folders."},"FeatureConfigurations":{"properties":{},"type":"object","title":"Citizen Data 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/catgrid_forms__engines__features__financial__credits__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"},"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"},"FlowHooksExtraDataType":{"additionalProperties":{"type":"string"},"type":"object","description":"Extra data to be included in the 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- `{parameters_id}`: The unique credentials ID, 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}"}]},"FlowRedirectExtraDataType":{"additionalProperties":{"type":"string"},"type":"object","description":"Extra data to be included in the redirect URL. This data will be added to the 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- `{status_code}`: The final status code of the session\nFor example, passing:\n```json\n{\n  \"custom_param\": \"customValue\",\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&status=COMPLETED&id=12345678&id=67d7d9b72eb0693e7da47a0e`_**Note:** This data is not encrypted and should not contain sensitive information._","examples":[{"custom_param":"customValue","id":"{session_id}","status":"{status_code}"}]},"FlowResultsSchema":{"properties":{"connections":{"additionalProperties":{"type":"string","format":"ObjectId","examples":["644599da47847b79c03cc94f"]},"propertyNames":{"format":"engine-reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"type":"object","title":"Connections","description":"Dict of connections"},"consent":{"$ref":"#/components/schemas/ConsentOutput","description":"Consents"},"data":{"$ref":"#/components/schemas/CitizenDataGlobalPositionSchema","description":"Citizen Data"}},"type":"object","required":["connections","consent"],"title":"Citizen Data v1 - Results"},"FlowSettingsSchema":{"properties":{"sandbox":{"type":"boolean","title":"Sandbox","description":"Indicates if the session is in sandbox mode."},"market":{"type":"string","const":"ES","title":"Market","description":"Market for the flow use case."},"executions_hooks_extra_data":{"$ref":"#/components/schemas/FlowHooksExtraDataType"},"executions_features":{"items":{"oneOf":[{"$ref":"#/components/schemas/FeatureCustomerInformationReadRequest"},{"$ref":"#/components/schemas/FeatureLaborCheckReadRequest"},{"$ref":"#/components/schemas/FeaturePublicPensionReadRequest"},{"$ref":"#/components/schemas/FeatureYearlyIndividualTaxRequest"},{"$ref":"#/components/schemas/FeatureCitizenDataReadRequest"},{"$ref":"#/components/schemas/FeatureDriverDataReadRequest"},{"$ref":"#/components/schemas/FeaturePropertiesDataReadRequest"},{"$ref":"#/components/schemas/FeatureAcademicDataReadRequest"}],"discriminator":{"propertyName":"code","mapping":{"academic_data":"#/components/schemas/FeatureAcademicDataReadRequest","citizen_data":"#/components/schemas/FeatureCitizenDataReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","driver_data":"#/components/schemas/FeatureDriverDataReadRequest","labor_check":"#/components/schemas/FeatureLaborCheckReadRequest","properties_data":"#/components/schemas/FeaturePropertiesDataReadRequest","public_pensions":"#/components/schemas/FeaturePublicPensionReadRequest","yearly_individual_tax":"#/components/schemas/FeatureYearlyIndividualTaxRequest"}}},"type":"array","title":"Executions Features","description":"Features to be executed by the engines"},"engines_to_features":{"additionalProperties":{"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"},"propertyNames":{"format":"engine-reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"type":"object","title":"Engines To Features","description":"Indicates the engine that will be used for each feature."},"completion_mode":{"type":"string","enum":["do_nothing","redirect","redirect_blank","close_tab"],"title":"FlowCompletionMode","description":"What to do when a flow is completed\nAllowed values are:\n - `do_nothing`: Leave the user in the final screen\n- `redirect`: Redirect in the same tab\n- `redirect_blank`: Redirect in a new tab\n- `close_tab`: Close the current tab"},"completion_url":{"type":"string","title":"Completion Url","description":"URL"},"completion_extra_data":{"$ref":"#/components/schemas/FlowRedirectExtraDataType"}},"type":"object","required":["market","executions_hooks_extra_data","executions_features","engines_to_features","completion_mode","completion_extra_data"],"title":"Citizen Data v1 - Settings"},"FlowStateSchema":{"properties":{"kind":{"type":"string","const":"bank_reader","title":"Kind"},"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","maxLength":64,"minLength":1,"title":"Customer Id","description":"Customer ID"},"session_token":{"type":"string","maxLength":20,"minLength":20,"format":"session-code","title":"Session Token","description":"Session token for the final customer","examples":["XXXXXXXXXXXXXXXXXXXX"]},"status_code":{"type":"string","enum":["READY","WAITING","COMPLETED","FAILED","SYSTEM_CANCELLED","CLIENT_CANCELLED","CUSTOMER_CANCELLED","TIMED_OUT","CONFIGURATION_ERROR"],"title":"FlowStatusCode","description":"Status code"},"status_message":{"type":"string","title":"Status Message","description":"Informative status message"},"date_created":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Session creation date & time","examples":["2023-10-05T14:46:36.546596Z"]},"date_started":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the customer started the session","examples":["2023-10-05T14:46:36.546596Z"]},"ping_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the customer last seen","examples":["2023-10-05T14:46:36.546596Z"]},"date_ended":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the session was ended","examples":["2023-10-05T14:46:36.546596Z"]},"date_limit":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Maximum date & time when the session is usable by the customer. After this the session will be closed automatically","examples":["2023-10-05T14:46:36.546596Z"]},"expiration_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the session will be auto-deleted","examples":["2023-10-05T14:46:36.546596Z"]},"end_hook":{"type":"string","enum":["skipped","pending","delivered","re_delivered","doubtful","failed","ko"],"title":"EventDeliverStatus","description":"Status of the end hook execution"},"is_closed":{"type":"boolean","title":"Is Closed","description":"Indicates if the session is closed","readOnly":true}},"type":"object","required":["kind","session_id","app_id","customer_id","session_token","status_code","date_created","date_limit","expiration_date","is_closed"],"title":"Bank Reader v1 - Session"},"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":"Country <ISO 3166-1>","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"},"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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","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 <ISO 3166-1>","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"},"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":"DateTime <UTC Localized>","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":"DateTime <UTC Localized>","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/CurrencyAmountSchema","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__1","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":"DateTime <UTC Localized>","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/CurrencyAmountSchema","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__1","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"},"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"},"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"},"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":"DateTime <UTC Localized>","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__1","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"},"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"},"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":"DateTime <UTC Localized>","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__1","description":"Total Performance"},"performance_year_to_date":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__1","description":"Year to date performance"},"performance_last_12_months":{"$ref":"#/components/schemas/catgrid_core__pydantic__fields__common__Rate__1","description":"Last 12 months performance"},"appreciation":{"$ref":"#/components/schemas/catgrid_core__schemas__utils__CurrencyAmountSchema__4","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":"DateTime <UTC Localized>","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__1","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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","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":"DateTime <UTC Localized>","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"},"PropertiesFamily":{"properties":{"es":{"items":{"$ref":"#/components/schemas/ESOwnedPropertySchema"},"type":"array","title":"Es","description":"Officially owned properties"}},"type":"object","title":"Properties Family"},"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","title":"Currency <ISO 4217>","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"},"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":"DateTime <UTC Localized>","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":"DateTime <UTC Localized>","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":"DateTime <UTC Localized>","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":"Country <ISO 3166-1>","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"},"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":"DateTime <UTC Localized>","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":"DateTime <UTC Localized>","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"},"TaxesFamily":{"properties":{"individual_yearly":{"items":{"$ref":"#/components/schemas/YearlyPersonalTaxSituationSchema"},"type":"array","title":"Individual Yearly","description":"Yearly individual tax situations"}},"type":"object","title":"Taxes Family"},"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":"DateTime <UTC Localized>","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"},"Update":{"properties":{"event":{"type":"string","title":"Event","description":"Event to trigger the hook"},"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","method","base_url"],"title":"Update Flow 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"},"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":"DateTime <UTC Localized>","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 <ISO 3166-1>","description":"Country code for the tax declaration","examples":["ES","US"]},"currency":{"type":"string","format":"currency","title":"Currency <ISO 4217>","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__1":{"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","title":"Currency <ISO 4217>","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__utils__CurrencyAmountSchema__1":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","title":"Currency <ISO 4217>","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__3":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","title":"Currency <ISO 4217>","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__4":{"properties":{"currency":{"anyOf":[{"type":"string","format":"currency","title":"Currency <ISO 4217>","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_flows__flows__bank_reader__v1__schemas__manager__FlowResultsSchema":{"properties":{"connections":{"additionalProperties":{"type":"string","format":"engine-reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"propertyNames":{"format":"ObjectId","examples":["644599da47847b79c03cc94f"]},"type":"object","title":"Connections","description":"Dict of connections"},"consent":{"$ref":"#/components/schemas/catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowResultsSchema__ConsentOutput","description":"Consents"},"data":{"$ref":"#/components/schemas/FinancialGlobalPositionSchema","description":"Financial Data"}},"type":"object","required":["connections","consent"],"title":"Bank Reader v1 - Results"},"catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowResultsSchema__ConsentOutput":{"properties":{"accepted_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the consent was accepted","examples":["2023-10-05T14:46:36.546596Z"]},"accepted_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":"Accepted Features","description":"Accepted features"},"user_ip":{"type":"string","title":"User Ip","description":"User IP"},"user_agent":{"type":"string","title":"User Agent","description":"User Agent"},"origin":{"type":"string","title":"Origin","description":"Origin"},"user_phone":{"type":"string","title":"User Phone","description":"User phone"},"user_email":{"type":"string","title":"User Email","description":"User email"},"user_full_name":{"type":"string","title":"User Full Name","description":"User full name"},"user_identification":{"$ref":"#/components/schemas/IdentificationNumberSchema","description":"User identification"}},"type":"object","required":["accepted_date","accepted_features"],"title":"Bank Reader v1 - Consent Output"},"catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowSettingsSchema":{"properties":{"sandbox":{"type":"boolean","title":"Sandbox","description":"Indicates if the session is in sandbox mode."},"allowed_engines":{"items":{"type":"string","format":"engine-reference","title":"Engine Reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"type":"array","title":"Allowed Engines","description":"Allowed engines"},"max_connections":{"type":"integer","title":"Max Connections","description":"Maximum bank connections for the session"},"max_failures":{"type":"integer","title":"Max Failures","description":"Maximum customer failures allowed for the session"},"tokenized_access":{"type":"boolean","title":"Tokenized Access","description":"If true, the engine will tokenize the credentials y its allowed by the engine. <br/>_**Note:** Requires your application to be enabled for tokenize credentials._"},"executions_hooks_extra_data":{"$ref":"#/components/schemas/FlowHooksExtraDataType"},"executions_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"}],"discriminator":{"propertyName":"code","mapping":{"accounts_read":"#/components/schemas/FeatureBankAccountsReadRequest","cards_read":"#/components/schemas/FeatureBankCardsReadRequest","credits_read":"#/components/schemas/FeatureCreditsReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","deposits_read":"#/components/schemas/FeatureBankDepositsReadRequest","direct_debits_read":"#/components/schemas/FeatureDirectDebitsReadRequest","funds_read":"#/components/schemas/FeatureBankFundsReadRequest","investment_accounts_read":"#/components/schemas/FeatureInvestmentAccountsReadRequest","loans_read":"#/components/schemas/FeatureBankLoansReadReadRequest","pensions_read":"#/components/schemas/FeaturePensionPlansReadRequest","source_contracts_read":"#/components/schemas/FeatureContractsReadRequest","stocks_read":"#/components/schemas/FeatureBankStocksReadRequest"}}},"type":"array","title":"Executions Features","description":"Features to be executed by the engines"},"completion_mode":{"type":"string","enum":["do_nothing","redirect","redirect_blank","close_tab"],"title":"FlowCompletionMode","description":"What to do when a flow is completed\nAllowed values are:\n - `do_nothing`: Leave the user in the final screen\n- `redirect`: Redirect in the same tab\n- `redirect_blank`: Redirect in a new tab\n- `close_tab`: Close the current tab"},"completion_url":{"type":"string","title":"Completion Url","description":"URL"},"completion_extra_data":{"$ref":"#/components/schemas/FlowRedirectExtraDataType"}},"type":"object","required":["allowed_engines","max_connections","max_failures","tokenized_access","executions_hooks_extra_data","executions_features","completion_mode","completion_extra_data"],"title":"Bank Reader v1 - Settings"},"catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowSettingsSchema__Create":{"properties":{"aes_key":{"type":"string","format":"base64","title":"Aes Key","description":"AES key for encryption (Base64 encoded). The key must be exactly 32 bytes long.","examples":["MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE="]},"sandbox":{"type":"boolean","title":"Sandbox","description":"Whether to use the sandbox environment for the session. Sandbox sessions does not use real data and is intended \nfor testing purposes, if not specified the application environment will determine the value."},"allowed_engines":{"anyOf":[{"items":{"type":"string","format":"engine-reference","title":"Engine Reference","examples":["CATGRIDENTITFIN100ES9999-mobile","CATGRIDENTITFIN100ES9999-website"]},"type":"array","minItems":1,"title":"Engines list","description":"A lis of engine references to be allowed to use by the session"},{"type":"string","format":"ObjectId","title":"Engine list ID","description":"An stored engine list ID to be allowed to use by the session","examples":["644599da47847b79c03cc94f"]}],"title":"Allowed Engines"},"max_connections":{"type":"integer","maximum":1.0,"minimum":1.0,"title":"Max Connections","description":"Maximum bank connections for the session"},"max_failures":{"type":"integer","maximum":3.0,"minimum":1.0,"title":"Max Failures","description":"Maximum customer failures allowed for the session"},"tokenized_access":{"type":"boolean","title":"Tokenized Access","description":"If true, the engine will tokenize the credentials y its allowed by the engine. <br/>_**Note:** Requires your application to be enabled for tokenize credentials._"},"executions_hooks_extra_data":{"$ref":"#/components/schemas/FlowHooksExtraDataType"},"executions_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"}],"discriminator":{"propertyName":"code","mapping":{"accounts_read":"#/components/schemas/FeatureBankAccountsReadRequest","cards_read":"#/components/schemas/FeatureBankCardsReadRequest","credits_read":"#/components/schemas/FeatureCreditsReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","deposits_read":"#/components/schemas/FeatureBankDepositsReadRequest","direct_debits_read":"#/components/schemas/FeatureDirectDebitsReadRequest","funds_read":"#/components/schemas/FeatureBankFundsReadRequest","investment_accounts_read":"#/components/schemas/FeatureInvestmentAccountsReadRequest","loans_read":"#/components/schemas/FeatureBankLoansReadReadRequest","pensions_read":"#/components/schemas/FeaturePensionPlansReadRequest","source_contracts_read":"#/components/schemas/FeatureContractsReadRequest","stocks_read":"#/components/schemas/FeatureBankStocksReadRequest"}}},"type":"array","title":"Executions Features","description":"Features to be executed by the engine"},"completion_mode":{"type":"string","enum":["do_nothing","redirect","redirect_blank","close_tab"],"title":"FlowCompletionMode","description":"What to do when a flow is completed\nAllowed values are:\n - `do_nothing`: Leave the user in the final screen\n- `redirect`: Redirect in the same tab\n- `redirect_blank`: Redirect in a new tab\n- `close_tab`: Close the current tab"},"completion_url":{"type":"string","title":"Completion Url","description":"URL to redirect the customer to after the session has been completed. Required if completion mode is `redirect` or `redirect_blank`. The host mus be present in the application `redirect_urls` configuration."},"completion_extra_data":{"$ref":"#/components/schemas/FlowRedirectExtraDataType"}},"additionalProperties":false,"type":"object","title":"Bank Reader v1 - Settings Payload"},"catgrid_flows__flows__bank_reader__v1__schemas__manager__FlowStateSchema__Acceptance":{"properties":{"session_id":{"type":"string","format":"ObjectId","title":"Session Id","description":"Session ID","examples":["644599da47847b79c03cc94f"]},"widget_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Widget Url","description":"Widget URL"},"session_token":{"type":"string","maxLength":20,"minLength":20,"format":"session-code","title":"Session Token","description":"Session token for the final customer","examples":["XXXXXXXXXXXXXXXXXXXX"]},"ticket":{"type":"string","maxLength":64,"minLength":64,"title":"Ticket","description":"Ticket for tokenization exchange"}},"type":"object","required":["session_id","widget_url","session_token","ticket"],"title":"Bank Reader v1 - Acceptance"},"catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowSettingsSchema__Create":{"properties":{"max_failures":{"type":"integer","maximum":20.0,"minimum":1.0,"title":"Max Failures","description":"Deprecated field, this config is now managed at service level","deprecated":true},"sandbox":{"type":"boolean","title":"Sandbox","description":"Whether to use the sandbox environment for the session. Sandbox sessions does not use real data and is intended \nfor testing purposes, if not specified the application environment will determine the value.\n "},"aes_key":{"type":"string","format":"base64","title":"Aes Key","description":"AES key for encryption (Base64 encoded). The key must be exactly 32 bytes long.","examples":["MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE="]},"executions_hooks_extra_data":{"$ref":"#/components/schemas/FlowHooksExtraDataType"},"executions_features":{"items":{"oneOf":[{"$ref":"#/components/schemas/FeatureCustomerInformationReadRequest"},{"$ref":"#/components/schemas/FeatureLaborCheckReadRequest"},{"$ref":"#/components/schemas/FeaturePublicPensionReadRequest"},{"$ref":"#/components/schemas/FeatureYearlyIndividualTaxRequest"},{"$ref":"#/components/schemas/FeatureCitizenDataReadRequest"},{"$ref":"#/components/schemas/FeatureDriverDataReadRequest"},{"$ref":"#/components/schemas/FeaturePropertiesDataReadRequest"},{"$ref":"#/components/schemas/FeatureAcademicDataReadRequest"}],"discriminator":{"propertyName":"code","mapping":{"academic_data":"#/components/schemas/FeatureAcademicDataReadRequest","citizen_data":"#/components/schemas/FeatureCitizenDataReadRequest","customer_information_read":"#/components/schemas/FeatureCustomerInformationReadRequest","driver_data":"#/components/schemas/FeatureDriverDataReadRequest","labor_check":"#/components/schemas/FeatureLaborCheckReadRequest","properties_data":"#/components/schemas/FeaturePropertiesDataReadRequest","public_pensions":"#/components/schemas/FeaturePublicPensionReadRequest","yearly_individual_tax":"#/components/schemas/FeatureYearlyIndividualTaxRequest"}}},"type":"array","title":"Executions Features","description":"Features to be executed by the engine"},"completion_mode":{"type":"string","enum":["do_nothing","redirect","redirect_blank","close_tab"],"title":"FlowCompletionMode","description":"What to do when a flow is completed\nAllowed values are:\n - `do_nothing`: Leave the user in the final screen\n- `redirect`: Redirect in the same tab\n- `redirect_blank`: Redirect in a new tab\n- `close_tab`: Close the current tab"},"completion_url":{"type":"string","title":"Completion Url","description":"URL to redirect the customer to after the session has been completed. Required if completion mode is `redirect` or `redirect_blank`. The host mus be present in the application `redirect_urls` configuration."},"completion_extra_data":{"$ref":"#/components/schemas/FlowRedirectExtraDataType"}},"additionalProperties":false,"type":"object","title":"Citizen Data v1 - Settings Payload"},"catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowStateSchema":{"properties":{"kind":{"type":"string","const":"es_citizen_data","title":"Kind"},"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","maxLength":64,"minLength":1,"title":"Customer Id","description":"Customer ID"},"session_token":{"type":"string","maxLength":20,"minLength":20,"format":"session-code","title":"Session Token","description":"Session token for the final customer","examples":["XXXXXXXXXXXXXXXXXXXX"]},"status_code":{"type":"string","enum":["READY","WAITING","COMPLETED","FAILED","SYSTEM_CANCELLED","CLIENT_CANCELLED","CUSTOMER_CANCELLED","TIMED_OUT","CONFIGURATION_ERROR"],"title":"FlowStatusCode","description":"Status code"},"status_message":{"type":"string","title":"Status Message","description":"Informative status message"},"date_created":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Session creation date & time","examples":["2023-10-05T14:46:36.546596Z"]},"date_started":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the customer started the session","examples":["2023-10-05T14:46:36.546596Z"]},"ping_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the customer last seen","examples":["2023-10-05T14:46:36.546596Z"]},"date_ended":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the session was ended","examples":["2023-10-05T14:46:36.546596Z"]},"date_limit":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Maximum date & time when the session is usable by the customer. After this the session will be closed automatically","examples":["2023-10-05T14:46:36.546596Z"]},"expiration_date":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Date & time when the session will be auto-deleted","examples":["2023-10-05T14:46:36.546596Z"]},"end_hook":{"type":"string","enum":["skipped","pending","delivered","re_delivered","doubtful","failed","ko"],"title":"EventDeliverStatus","description":"Status of the end hook execution"},"is_closed":{"type":"boolean","title":"Is Closed","description":"Indicates if the session is closed","readOnly":true}},"type":"object","required":["kind","session_id","app_id","customer_id","session_token","status_code","date_created","date_limit","expiration_date","is_closed"],"title":"Citizen Data v1 - Session"},"catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowStateSchema__Create":{"properties":{"customer_id":{"type":"string","maxLength":64,"minLength":1,"title":"Customer Id","description":"External ID of the customer. Refers to the end user.<br/>_**Note:** This ID is relevant for statistics and billing purposes._","examples":["test-customer-1234"]},"date_limit":{"type":"string","format":"datetime","title":"DateTime <UTC Localized>","description":"Maximum date and time when the session is usable by the customer. _If not provided, the session will be valid for 72 hours._","examples":["2023-10-05T14:46:36.546596Z"]},"settings":{"$ref":"#/components/schemas/catgrid_flows__flows__es_citizen_data__v1__schemas__manager__FlowSettingsSchema__Create","description":"Session Settings"}},"additionalProperties":false,"type":"object","required":["customer_id","settings"],"title":"Citizen Data v1 - Create Session"},"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__financial__credits__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"},"catgrid_forms__engines__features__public__academic_data__FeatureConfigurations":{"properties":{},"type":"object","title":"Academic 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":"[Manager] Flows","description":"INFONITE Flows"},{"name":"[Flows] Bank Reader","description":"Bank Reader"},{"name":"[Flows] Spain Citizen Data","description":"Spain / Citizen Data"},{"name":"[Manager] Manual Sessions","description":"Manual Sessions Management"},{"name":"[Customer] Manual Session Handling","description":"Customer Session Handling"},{"name":"[Customer] Execution Handling","description":"Engines Marketplace"},{"name":"[Customer] Customer Profile Data","description":"Customer Profile Data"},{"name":"[Customer] Financial Data","description":"Financial Data"},{"name":"[Customer] Commercial Data","description":"Commercial Data"},{"name":"[Customer] Public Administration Data","description":"Public Administration Data"},{"name":"[Customer] Other Data","description":"Other Data"}]}