{"items":[{"type":"link","label":"Upvest Investment API","link":"/api","routeSlug":"/api","content":{"contentType":"overview","meta":{"name":"Upvest Investment API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://docs.upvest.co","url":"https://docs.upvest.co"},{"kind":"email","title":"Upvest API Support","email":"api@upvest.co","label":"api@upvest.co","withCopyButton":true,"copyContent":"api@upvest.co"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Upvest Investment API (1.135.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Upvest Investment API."}],"sectionId":"/api"}],"sectionId":"/api"}]}]}},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Access Tokens","link":"/api/access-tokens","routeSlug":"/api/access-tokens","items":[{"label":"Get an access token for requested scopes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/access-tokens/issue_token","routeSlug":"/api/access-tokens/issue_token","metadata":{"seo":{"title":"Get an access token for requested scopes","description":"Get an access token to use with the API with specified scopes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"issue_token","name":"Get an access token for requested scopes","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an access token for requested scopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get an access token to use with the API with specified scopes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope your access tokens. You get one for read-access and separate ones for updating, creating or deleting resources."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1auth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_882","exampleIds":["paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_882","exampleIds":["paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1auth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_882","exampleIds":["paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/auth/token","href":"access-tokens/issue_token","openApiOperationId":"issue_token","summary":"Get an access token for requested scopes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_882","exampleIds":["paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_882","exampleIds":["paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access token successfully generated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883","exampleIds":["paths/~1auth~1token/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_883","exampleIds":["paths/~1auth~1token/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_883","exampleIds":["paths/~1auth~1token/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883","exampleIds":["paths/~1auth~1token/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1token/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-tokens/issue_token"}],"panels":[]}]},"httpPath":"/auth/token"}],"content":{"contentType":"group","meta":{"name":"Access Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Tokens","showPageActions":true},{"nodeType":"markdoc","content":"All authentication related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/token","summary":"Get an access token for requested scopes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/access-tokens/issue_token","deprecated":false}]}]}]}]}},{"type":"separator","label":"Users and Businesses","content":null},{"type":"group","label":"Users","link":"/api/users","routeSlug":"/api/users","items":[{"label":"Get all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/list_users","routeSlug":"/api/users/list_users","metadata":{"seo":{"title":"Get all users","description":"Returns the list of all users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_users","name":"Get all users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of all users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:read","users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:read","users:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/users","href":"users/list_users","openApiOperationId":"list_users","summary":"Get all users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/BYOL","paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/TOL","paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"schema_891","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/BYOL","paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/TOL","paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/empty"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_891","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/BYOL","paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/TOL","paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/BYOL","paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/TOL","paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/list_users"}],"panels":[]}]},"httpPath":"/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/create_user","routeSlug":"/api/users/create_user","metadata":{"seo":{"title":"Create a user","description":"Creates a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_user","name":"Create a user","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1users/post/requestBody/content/application~1json/examples/BYOL","paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL","paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"]}},"schemaId":"schema_893","exampleIds":["paths/~1users/post/requestBody/content/application~1json/examples/BYOL","paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL","paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"],"pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1users/post/requestBody/content/application~1json/examples/BYOL","paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL","paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"]}},"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/users","href":"users/create_user","openApiOperationId":"create_user","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_893","exampleIds":["paths/~1users/post/requestBody/content/application~1json/examples/BYOL","paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL","paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1users/post/requestBody/content/application~1json/examples/BYOL","paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL","paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID","paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894","exampleIds":["paths/~1users/post/responses/200/content/application~1json/examples/BYOL","paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL","paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents"]}},"schemaId":"schema_894","exampleIds":["paths/~1users/post/responses/200/content/application~1json/examples/BYOL","paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL","paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_894","exampleIds":["paths/~1users/post/responses/200/content/application~1json/examples/BYOL","paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL","paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894","exampleIds":["paths/~1users/post/responses/200/content/application~1json/examples/BYOL","paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL","paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID","paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/create_user"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get a user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/retrieve_user","routeSlug":"/api/users/retrieve_user","metadata":{"seo":{"title":"Get a user by ID","description":"Returns the user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_user","name":"Get a user by ID","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:read","users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:read","users:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}","href":"users/retrieve_user","openApiOperationId":"retrieve_user","summary":"Get a user by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents"]}},"schemaId":"schema_896","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_896","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID","paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/retrieve_user"}],"panels":[]}]},"httpPath":"/users/{user_id}"},{"label":"Offboard a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/offboard_user","routeSlug":"/api/users/offboard_user","metadata":{"seo":{"title":"Offboard a user","description":"Starts the user offboarding process in the background."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"offboard_user","name":"Offboard a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offboard a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the user offboarding process in the background."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{user_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:admin"]}],"responseCodes":["202","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}","href":"users/offboard_user","openApiOperationId":"offboard_user","summary":"Offboard a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/offboard_user"}],"panels":[]}]},"httpPath":"/users/{user_id}"},{"label":"Change user data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/user_data_change","routeSlug":"/api/users/user_data_change","metadata":{"seo":{"title":"Change user data","description":"Requests a data change for a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"user_data_change","name":"Change user data","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1data_change_requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change user data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests a data change for a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1data_change_requests/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1data_change_requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"]}},"schemaId":"schema_897","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"],"pointer":"/paths/~1users~1{user_id}~1data_change_requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/data_change_requests","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/data_change_requests","href":"users/user_data_change","openApiOperationId":"user_data_change","summary":"Change user data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_897","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change","paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1data_change_requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/user_data_change"}],"panels":[]}]},"httpPath":"/users/{user_id}/data_change_requests"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Users events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/users/user_event","routeSlug":"/api/users/user_event","metadata":{"seo":{"title":"Users events","description":"Users events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"user_event","name":"Users events","isWebhook":true,"pointer":"/paths/Users events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Users events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/Users events/post/requestBody/content/application~1json/examples/BYOL","paths/Users events/post/requestBody/content/application~1json/examples/TOL"]}},"schemaId":"schema_898","exampleIds":["paths/Users events/post/requestBody/content/application~1json/examples/BYOL","paths/Users events/post/requestBody/content/application~1json/examples/TOL"],"pointer":"/paths/Users events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Users events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/Users events/post/requestBody/content/application~1json/examples/BYOL","paths/Users events/post/requestBody/content/application~1json/examples/TOL"]}},"responseCodes":["200"],"pointer":"Users events","href":"users/user_event","openApiOperationId":"user_event","summary":"Users events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_898","exampleIds":["paths/Users events/post/requestBody/content/application~1json/examples/BYOL","paths/Users events/post/requestBody/content/application~1json/examples/TOL"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/Users events/post/requestBody/content/application~1json/examples/BYOL","paths/Users events/post/requestBody/content/application~1json/examples/TOL"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Users events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/user_event"}],"panels":[]}]},"httpPath":"Users events"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"All user related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Get all users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/list_users","deprecated":false},{"title":"/users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/create_user","deprecated":false},{"title":"/users/{user_id}","summary":"Get a user by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/retrieve_user","deprecated":false},{"title":"/users/{user_id}","summary":"Offboard a user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/offboard_user","deprecated":false},{"title":"/users/{user_id}/data_change_requests","summary":"Change user data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/user_data_change","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Users events","summary":"Users events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/user_event","deprecated":false}]}]}]}]}},{"type":"group","label":"User Identifiers","link":"/api/user-identifiers","routeSlug":"/api/user-identifiers","items":[{"label":"Get user identifiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-identifiers/list_user_identifiers","routeSlug":"/api/user-identifiers/list_user_identifiers","metadata":{"seo":{"title":"Get user identifiers","description":"Lists all existing identifiers of a user used for transaction reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_identifiers","name":"Get user identifiers","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1identifiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user identifiers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all existing identifiers of a user used for transaction reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:read","users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1identifiers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1identifiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/identifiers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:read","users:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/identifiers","href":"user-identifiers/list_user_identifiers","openApiOperationId":"list_user_identifiers","summary":"Get user identifiers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_899","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_899","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1identifiers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_899","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_899","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-identifiers/list_user_identifiers"}],"panels":[]}]},"httpPath":"/users/{user_id}/identifiers"},{"label":"Create a user identifier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-identifiers/create_identifier","routeSlug":"/api/user-identifiers/create_identifier","metadata":{"seo":{"title":"Create a user identifier","description":"Creates a new identifier for a user that will be used for transaction reporting obligations. This identifier is required for user activation if the user's nationalities do not allow reporting using the CONCAT format. More information can be found in the guides."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_identifier","name":"Create a user identifier","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1identifiers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new identifier for a user that will be used for transaction reporting obligations. This identifier is required for user activation if the user's nationalities do not allow reporting using the CONCAT format. More information can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.upvest.co/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1identifiers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1identifiers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_900","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"]}},"schemaId":"schema_900","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"],"pointer":"/paths/~1users~1{user_id}~1identifiers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/identifiers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_900","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/identifiers","href":"user-identifiers/create_identifier","openApiOperationId":"create_identifier","summary":"Create a user identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_900","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_900","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport","paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user identifier is created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport"]}},"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1identifiers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id","paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-identifiers/create_identifier"}],"panels":[]}]},"httpPath":"/users/{user_id}/identifiers"},{"label":"Get a user identifier by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-identifiers/retrieve_identifier","routeSlug":"/api/user-identifiers/retrieve_identifier","metadata":{"seo":{"title":"Get a user identifier by ID","description":"Returns an existing identifier of a given user used for transaction reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_identifier","name":"Get a user identifier by ID","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user identifier by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing identifier of a given user used for transaction reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:read","users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true},{"name":"identifier_id","in":"path","schemaId":"schema_902","required":true}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/identifiers/{identifier_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"},{"name":"identifier_id","in":"path","required":true,"schemaId":"schema_902"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:read","users:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/identifiers/{identifier_id}","href":"user-identifiers/retrieve_identifier","openApiOperationId":"retrieve_identifier","summary":"Get a user identifier by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-identifiers/retrieve_identifier"}],"panels":[]}]},"httpPath":"/users/{user_id}/identifiers/{identifier_id}"},{"label":"Update a user identifier by ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-identifiers/update_identifier","routeSlug":"/api/user-identifiers/update_identifier","metadata":{"seo":{"title":"Update a user identifier by ID","description":"Updates an existing identifier of a given user used for transaction reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_identifier","name":"Update a user identifier by ID","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user identifier by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing identifier of a given user used for transaction reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["users:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true},{"name":"identifier_id","in":"path","schemaId":"schema_902","required":true}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_903","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_903","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/users/{user_id}/identifiers/{identifier_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"},{"name":"identifier_id","in":"path","required":true,"schemaId":"schema_902"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["users:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_903","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/identifiers/{identifier_id}","href":"user-identifiers/update_identifier","openApiOperationId":"update_identifier","summary":"Update a user identifier by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_903","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_903","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user identifier is updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-identifiers/update_identifier"}],"panels":[]}]},"httpPath":"/users/{user_id}/identifiers/{identifier_id}"}],"content":{"contentType":"group","meta":{"name":"User Identifiers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Identifiers","showPageActions":true},{"nodeType":"markdoc","content":"All user identifiers related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/identifiers","summary":"Get user identifiers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-identifiers/list_user_identifiers","deprecated":false},{"title":"/users/{user_id}/identifiers","summary":"Create a user identifier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-identifiers/create_identifier","deprecated":false},{"title":"/users/{user_id}/identifiers/{identifier_id}","summary":"Get a user identifier by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-identifiers/retrieve_identifier","deprecated":false},{"title":"/users/{user_id}/identifiers/{identifier_id}","summary":"Update a user identifier by ID","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-identifiers/update_identifier","deprecated":false}]}]}]}]}},{"type":"group","label":"User Checks","link":"/api/user-checks","routeSlug":"/api/user-checks","items":[{"label":"Get checks for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-checks/list_user_checks","routeSlug":"/api/user-checks/list_user_checks","metadata":{"seo":{"title":"Get checks for a user","description":"Lists all checks for a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_checks","name":"Get checks for a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1checks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get checks for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all checks for a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:read","checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1checks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"list_history","in":"query","schemaId":"schema_904","description":"If true, return the full history of checks (all records) instead of only the latest check per type."},{"name":"type","in":"query","schemaId":"schema_905","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter the returned checks to a single allowed check type (e.g. US_WITHHOLDING_TAX_STATUS)."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1checks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1checks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/checks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"list_history","in":"query","required":false,"schemaId":"schema_904"},{"name":"type","in":"query","required":false,"schemaId":"schema_905"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:read","checks:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/checks","href":"user-checks/list_user_checks","openApiOperationId":"list_user_checks","summary":"Get checks for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_906","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_906","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1checks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_906","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_906","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-checks/list_user_checks"}],"panels":[]}]},"httpPath":"/users/{user_id}/checks"},{"label":"Create a new check for a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-checks/create_user_check","routeSlug":"/api/user-checks/create_user_check","metadata":{"seo":{"title":"Create a new check for a user","description":"Creates a new check for a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_user_check","name":"Create a new check for a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1checks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new check for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new check for a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1checks/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1checks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_907","exampleIds":["paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"]}},"schemaId":"schema_907","exampleIds":["paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"],"pointer":"/paths/~1users~1{user_id}~1checks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/checks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_907","exampleIds":["paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/checks","href":"user-checks/create_user_check","openApiOperationId":"create_user_check","summary":"Create a new check for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_907","exampleIds":["paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_907","exampleIds":["paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_908","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_908","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1checks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_908","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_908","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-checks/create_user_check"}],"panels":[]}]},"httpPath":"/users/{user_id}/checks"},{"label":"Get a user check by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/user-checks/retrieve_user_check","routeSlug":"/api/user-checks/retrieve_user_check","metadata":{"seo":{"title":"Get a user check by ID","description":"Retrieves a check for a user specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_user_check","name":"Get a user check by ID","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1checks~1{check_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user check by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a check for a user specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:read","checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true},{"name":"check_id","in":"path","schemaId":"schema_909","required":true}],"pointer":"/paths/~1users~1{user_id}~1checks~1{check_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1checks~1{check_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/checks/{check_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"},{"name":"check_id","in":"path","required":true,"schemaId":"schema_909"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:read","checks:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/checks/{check_id}","href":"user-checks/retrieve_user_check","openApiOperationId":"retrieve_user_check","summary":"Get a user check by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_910","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN"]}},"schemaId":"schema_910","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1checks~1{check_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_910","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_910","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE","paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-checks/retrieve_user_check"}],"panels":[]}]},"httpPath":"/users/{user_id}/checks/{check_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"User checks events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/user-checks/user_checks_event","routeSlug":"/api/user-checks/user_checks_event","metadata":{"seo":{"title":"User checks events","description":"User checks events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"user_checks_event","name":"User checks events","isWebhook":true,"pointer":"/paths/User checks events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User checks events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"User checks events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_911","exampleIds":["paths/User checks events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_911","exampleIds":["paths/User checks events/post/requestBody/content/application~1json/example"],"pointer":"/paths/User checks events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"User checks events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_911","exampleIds":["paths/User checks events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"User checks events","href":"user-checks/user_checks_event","openApiOperationId":"user_checks_event","summary":"User checks events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_911","exampleIds":["paths/User checks events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_911","exampleIds":["paths/User checks events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/User checks events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-checks/user_checks_event"}],"panels":[]}]},"httpPath":"User checks events"}],"content":{"contentType":"group","meta":{"name":"User Checks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Checks","showPageActions":true},{"nodeType":"markdoc","content":"All user checks related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/checks","summary":"Get checks for a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-checks/list_user_checks","deprecated":false},{"title":"/users/{user_id}/checks","summary":"Create a new check for a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-checks/create_user_check","deprecated":false},{"title":"/users/{user_id}/checks/{check_id}","summary":"Get a user check by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-checks/retrieve_user_check","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"User checks events","summary":"User checks events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-checks/user_checks_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Businesses","link":"/api/businesses","routeSlug":"/api/businesses","items":[{"label":"Get all businesses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/businesses/list_businesses","routeSlug":"/api/businesses/list_businesses","metadata":{"seo":{"title":"Get all businesses","description":"Returns the list of all businesses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_businesses","name":"Get all businesses","isWebhook":false,"pointer":"/paths/~1businesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all businesses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of all businesses."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["businesses:read","businesses:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["businesses:read","businesses:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/businesses","href":"businesses/list_businesses","openApiOperationId":"list_businesses","summary":"Get all businesses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_912","exampleIds":["paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses","paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List"]}},"schemaId":"schema_912","exampleIds":["paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses","paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_912","exampleIds":["paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses","paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_912","exampleIds":["paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses","paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/list_businesses"}],"panels":[]}]},"httpPath":"/businesses"},{"label":"Create a business","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/businesses/create_business","routeSlug":"/api/businesses/create_business","metadata":{"seo":{"title":"Create a business","description":"Creates a business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_business","name":"Create a business","isWebhook":false,"pointer":"/paths/~1businesses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["businesses:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_913","exampleIds":["paths/~1businesses/post/requestBody/content/application~1json/examples/Company","paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"]}},"schemaId":"schema_913","exampleIds":["paths/~1businesses/post/requestBody/content/application~1json/examples/Company","paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"],"pointer":"/paths/~1businesses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/businesses","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["businesses:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_913","exampleIds":["paths/~1businesses/post/requestBody/content/application~1json/examples/Company","paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"]}},"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/businesses","href":"businesses/create_business","openApiOperationId":"create_business","summary":"Create a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_913","exampleIds":["paths/~1businesses/post/requestBody/content/application~1json/examples/Company","paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_913","exampleIds":["paths/~1businesses/post/requestBody/content/application~1json/examples/Company","paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Business created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_914","exampleIds":["paths/~1businesses/post/responses/200/content/application~1json/examples/Company","paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader"]}},"schemaId":"schema_914","exampleIds":["paths/~1businesses/post/responses/200/content/application~1json/examples/Company","paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_914","exampleIds":["paths/~1businesses/post/responses/200/content/application~1json/examples/Company","paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_914","exampleIds":["paths/~1businesses/post/responses/200/content/application~1json/examples/Company","paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/create_business"}],"panels":[]}]},"httpPath":"/businesses"},{"label":"Get a business by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/businesses/retrieve_business","routeSlug":"/api/businesses/retrieve_business","metadata":{"seo":{"title":"Get a business by ID","description":"Returns the business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_business","name":"Get a business by ID","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a business by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["businesses:read","businesses:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["businesses:read","businesses:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}","href":"businesses/retrieve_business","openApiOperationId":"retrieve_business","summary":"Get a business by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_916","exampleIds":["paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company","paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader"]}},"schemaId":"schema_916","exampleIds":["paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company","paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_916","exampleIds":["paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company","paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_916","exampleIds":["paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company","paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/retrieve_business"}],"panels":[]}]},"httpPath":"/businesses/{business_id}"},{"label":"Change business data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/businesses/business_data_change","routeSlug":"/api/businesses/business_data_change","metadata":{"seo":{"title":"Change business data","description":"Requests a data change for a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"business_data_change","name":"Change business data","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1data_change_requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change business data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests a data change for a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["businesses:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1data_change_requests/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1data_change_requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_917","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"]}},"schemaId":"schema_917","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"],"pointer":"/paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/businesses/{business_id}/data_change_requests","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["businesses:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_917","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/data_change_requests","href":"businesses/business_data_change","openApiOperationId":"business_data_change","summary":"Change business data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_917","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_917","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1data_change_requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/business_data_change"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/data_change_requests"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Business events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/businesses/business_event","routeSlug":"/api/businesses/business_event","metadata":{"seo":{"title":"Business events","description":"Business events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"business_event","name":"Business events","isWebhook":true,"pointer":"/paths/Business events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Business events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_918","exampleIds":["paths/Business events/post/requestBody/content/application~1json/examples/Company","paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"]}},"schemaId":"schema_918","exampleIds":["paths/Business events/post/requestBody/content/application~1json/examples/Company","paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"],"pointer":"/paths/Business events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Business events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_918","exampleIds":["paths/Business events/post/requestBody/content/application~1json/examples/Company","paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"]}},"responseCodes":["200"],"pointer":"Business events","href":"businesses/business_event","openApiOperationId":"business_event","summary":"Business events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_918","exampleIds":["paths/Business events/post/requestBody/content/application~1json/examples/Company","paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_918","exampleIds":["paths/Business events/post/requestBody/content/application~1json/examples/Company","paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Business events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/business_event"}],"panels":[]}]},"httpPath":"Business events"}],"content":{"contentType":"group","meta":{"name":"Businesses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Businesses","showPageActions":true},{"nodeType":"markdoc","content":"All Businesses related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/businesses","summary":"Get all businesses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/list_businesses","deprecated":false},{"title":"/businesses","summary":"Create a business","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/create_business","deprecated":false},{"title":"/businesses/{business_id}","summary":"Get a business by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/retrieve_business","deprecated":false},{"title":"/businesses/{business_id}/data_change_requests","summary":"Change business data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/business_data_change","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Business events","summary":"Business events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/business_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Business Checks","link":"/api/business-checks","routeSlug":"/api/business-checks","items":[{"label":"List checks for a business","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/business-checks/list_business_checks","routeSlug":"/api/business-checks/list_business_checks","metadata":{"seo":{"title":"List checks for a business","description":"Lists all checks for a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_checks","name":"List checks for a business","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1checks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List checks for a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all checks for a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:read","checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1checks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1checks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/checks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:read","checks:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/checks","href":"business-checks/list_business_checks","openApiOperationId":"list_business_checks","summary":"List checks for a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_919","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_919","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1checks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_919","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_919","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-checks/list_business_checks"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/checks"},{"label":"Create a new check for a business","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/business-checks/create_business_check","routeSlug":"/api/business-checks/create_business_check","metadata":{"seo":{"title":"Create a new check for a business","description":"Creates a new check for a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_business_check","name":"Create a new check for a business","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1checks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new check for a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new check for a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1checks/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1checks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_920","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"]}},"schemaId":"schema_920","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"],"pointer":"/paths/~1businesses~1{business_id}~1checks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/businesses/{business_id}/checks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_920","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/checks","href":"business-checks/create_business_check","openApiOperationId":"create_business_check","summary":"Create a new check for a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_920","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_920","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_921","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_921","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1checks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_921","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_921","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-checks/create_business_check"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/checks"},{"label":"Get a business check by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/business-checks/retrieve_business_check","routeSlug":"/api/business-checks/retrieve_business_check","metadata":{"seo":{"title":"Get a business check by ID","description":"Retrieves a check for a business specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_business_check","name":"Get a business check by ID","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1checks~1{check_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a business check by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a check for a business specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["checks:read","checks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true},{"name":"check_id","in":"path","schemaId":"schema_909","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1checks~1{check_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1checks~1{check_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/checks/{check_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"},{"name":"check_id","in":"path","required":true,"schemaId":"schema_909"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["checks:read","checks:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/checks/{check_id}","href":"business-checks/retrieve_business_check","openApiOperationId":"retrieve_business_check","summary":"Get a business check by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_922","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"]}},"schemaId":"schema_922","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_922","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_922","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB","paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-checks/retrieve_business_check"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/checks/{check_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Business checks events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/business-checks/business_checks_event","routeSlug":"/api/business-checks/business_checks_event","metadata":{"seo":{"title":"Business checks events","description":"Business checks events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"business_checks_event","name":"Business checks events","isWebhook":true,"pointer":"/paths/Business checks events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business checks events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Business checks events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_923","exampleIds":["paths/Business checks events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_923","exampleIds":["paths/Business checks events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Business checks events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Business checks events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_923","exampleIds":["paths/Business checks events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Business checks events","href":"business-checks/business_checks_event","openApiOperationId":"business_checks_event","summary":"Business checks events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_923","exampleIds":["paths/Business checks events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_923","exampleIds":["paths/Business checks events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Business checks events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-checks/business_checks_event"}],"panels":[]}]},"httpPath":"Business checks events"}],"content":{"contentType":"group","meta":{"name":"Business Checks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Checks","showPageActions":true},{"nodeType":"markdoc","content":"All Business Checks related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/businesses/{business_id}/checks","summary":"List checks for a business","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-checks/list_business_checks","deprecated":false},{"title":"/businesses/{business_id}/checks","summary":"Create a new check for a business","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-checks/create_business_check","deprecated":false},{"title":"/businesses/{business_id}/checks/{check_id}","summary":"Get a business check by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-checks/retrieve_business_check","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Business checks events","summary":"Business checks events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-checks/business_checks_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/api/roles","routeSlug":"/api/roles","items":[{"label":"Get all roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/roles/list_roles","routeSlug":"/api/roles/list_roles","metadata":{"seo":{"title":"Get all roles","description":"Returns the list of all roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_roles","name":"Get all roles","isWebhook":false,"pointer":"/paths/~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of all roles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["roles:read","roles:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"user_id","in":"query","schemaId":"schema_895"},{"name":"entity_id","in":"query","schemaId":"schema_924"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1roles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_895"},{"name":"entity_id","in":"query","required":false,"schemaId":"schema_924"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["roles:read","roles:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/roles","href":"roles/list_roles","openApiOperationId":"list_roles","summary":"Get all roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_925","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/List Roles","paths/~1roles/get/responses/200/content/application~1json/examples/Empty List"]}},"schemaId":"schema_925","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/List Roles","paths/~1roles/get/responses/200/content/application~1json/examples/Empty List"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_925","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/List Roles","paths/~1roles/get/responses/200/content/application~1json/examples/Empty List"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_925","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/List Roles","paths/~1roles/get/responses/200/content/application~1json/examples/Empty List"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/list_roles"}],"panels":[]}]},"httpPath":"/roles"},{"label":"Create a role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/roles/create_role","routeSlug":"/api/roles/create_role","metadata":{"seo":{"title":"Create a role","description":"Creates a role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_role","name":"Create a role","isWebhook":false,"pointer":"/paths/~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["roles:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_926","exampleIds":["paths/~1roles/post/requestBody/content/application~1json/examples/Account Group","paths/~1roles/post/requestBody/content/application~1json/examples/Business"]}},"schemaId":"schema_926","exampleIds":["paths/~1roles/post/requestBody/content/application~1json/examples/Account Group","paths/~1roles/post/requestBody/content/application~1json/examples/Business"],"pointer":"/paths/~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/roles","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["roles:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_926","exampleIds":["paths/~1roles/post/requestBody/content/application~1json/examples/Account Group","paths/~1roles/post/requestBody/content/application~1json/examples/Business"]}},"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/roles","href":"roles/create_role","openApiOperationId":"create_role","summary":"Create a role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_926","exampleIds":["paths/~1roles/post/requestBody/content/application~1json/examples/Account Group","paths/~1roles/post/requestBody/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_926","exampleIds":["paths/~1roles/post/requestBody/content/application~1json/examples/Account Group","paths/~1roles/post/requestBody/content/application~1json/examples/Business"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Role created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_927","exampleIds":["paths/~1roles/post/responses/200/content/application~1json/examples/Account Group","paths/~1roles/post/responses/200/content/application~1json/examples/Business"]}},"schemaId":"schema_927","exampleIds":["paths/~1roles/post/responses/200/content/application~1json/examples/Account Group","paths/~1roles/post/responses/200/content/application~1json/examples/Business"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_927","exampleIds":["paths/~1roles/post/responses/200/content/application~1json/examples/Account Group","paths/~1roles/post/responses/200/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_927","exampleIds":["paths/~1roles/post/responses/200/content/application~1json/examples/Account Group","paths/~1roles/post/responses/200/content/application~1json/examples/Business"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/create_role"}],"panels":[]}]},"httpPath":"/roles"},{"label":"Get a role by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/roles/retrieve_role","routeSlug":"/api/roles/retrieve_role","metadata":{"seo":{"title":"Get a role by ID","description":"Returns the role specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_role","name":"Get a role by ID","isWebhook":false,"pointer":"/paths/~1roles~1{role_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a role by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the role specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["roles:read","roles:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_928","required":true}],"pointer":"/paths/~1roles~1{role_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1roles~1{role_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles/{role_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_928"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["roles:read","roles:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/roles/{role_id}","href":"roles/retrieve_role","openApiOperationId":"retrieve_role","summary":"Get a role by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_929","exampleIds":["paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group","paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business"]}},"schemaId":"schema_929","exampleIds":["paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group","paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1roles~1{role_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_929","exampleIds":["paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group","paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_929","exampleIds":["paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group","paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/retrieve_role"}],"panels":[]}]},"httpPath":"/roles/{role_id}"},{"label":"Deactivate a role by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/roles/role_deactivation","routeSlug":"/api/roles/role_deactivation","metadata":{"seo":{"title":"Deactivate a role by ID","description":"Deactivates the role specified by its ID. The role remains queryable with status DEACTIVATED.Only roles whose entity_type is BUSINESS may be deactivated via this endpoint; account-group roles are rejected with 403 Forbidden.Deactivation is a terminal state; once deactivated, a role cannot be reactivated.Deactivation is idempotent: calling this endpoint on an already-deactivated role returns 202 Accepted without side effects.A ROLE.DEACTIVATED webhook event is emitted on the first successful deactivation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"role_deactivation","name":"Deactivate a role by ID","isWebhook":false,"pointer":"/paths/~1roles~1{role_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a role by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates the role specified by its ID. The role remains queryable with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only roles whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be deactivated via this endpoint; account-group roles are rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivation is a terminal state; once deactivated, a role cannot be reactivated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivation is idempotent: calling this endpoint on an already-deactivated role returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without side effects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE.DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook event is emitted on the first successful deactivation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["roles:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_928","required":true}],"pointer":"/paths/~1roles~1{role_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1roles~1{role_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/roles/{role_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_928"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["roles:admin"]}],"responseCodes":["202","401","403","404","406","429","500","503","504"],"pointer":"/roles/{role_id}","href":"roles/role_deactivation","openApiOperationId":"role_deactivation","summary":"Deactivate a role by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1roles~1{role_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/role_deactivation"}],"panels":[]}]},"httpPath":"/roles/{role_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Role events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/roles/role_event","routeSlug":"/api/roles/role_event","metadata":{"seo":{"title":"Role events","description":"Role events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"role_event","name":"Role events","isWebhook":true,"pointer":"/paths/Role events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Role events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_930","exampleIds":["paths/Role events/post/requestBody/content/application~1json/examples/Account Group","paths/Role events/post/requestBody/content/application~1json/examples/Business"]}},"schemaId":"schema_930","exampleIds":["paths/Role events/post/requestBody/content/application~1json/examples/Account Group","paths/Role events/post/requestBody/content/application~1json/examples/Business"],"pointer":"/paths/Role events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Role events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_930","exampleIds":["paths/Role events/post/requestBody/content/application~1json/examples/Account Group","paths/Role events/post/requestBody/content/application~1json/examples/Business"]}},"responseCodes":["200"],"pointer":"Role events","href":"roles/role_event","openApiOperationId":"role_event","summary":"Role events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_930","exampleIds":["paths/Role events/post/requestBody/content/application~1json/examples/Account Group","paths/Role events/post/requestBody/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_930","exampleIds":["paths/Role events/post/requestBody/content/application~1json/examples/Account Group","paths/Role events/post/requestBody/content/application~1json/examples/Business"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Role events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/role_event"}],"panels":[]}]},"httpPath":"Role events"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"All Roles related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/roles","summary":"Get all roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/list_roles","deprecated":false},{"title":"/roles","summary":"Create a role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/create_role","deprecated":false},{"title":"/roles/{role_id}","summary":"Get a role by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/retrieve_role","deprecated":false},{"title":"/roles/{role_id}","summary":"Deactivate a role by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/roles/role_deactivation","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Role events","summary":"Role events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/role_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Residencies","link":"/api/tax-residencies","routeSlug":"/api/tax-residencies","items":[{"label":"Retrieve tax residencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-residencies/retrieve_tax_residencies","routeSlug":"/api/tax-residencies/retrieve_tax_residencies","metadata":{"seo":{"title":"Retrieve tax residencies","description":"Retrieve tax residencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_tax_residencies","name":"Retrieve tax residencies","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1tax_residencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tax residencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve tax residencies"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:read","taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/tax_residencies","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:read","taxes:admin"]}],"responseCodes":["200","401","403","404","405","406","429","500","503","504"],"pointer":"/users/{user_id}/tax_residencies","href":"tax-residencies/retrieve_tax_residencies","openApiOperationId":"retrieve_tax_residencies","summary":"Retrieve tax residencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User tax residencies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-residencies/retrieve_tax_residencies"}],"panels":[]}]},"httpPath":"/users/{user_id}/tax_residencies"},{"label":"Update tax residencies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-residencies/set_tax_residencies","routeSlug":"/api/tax-residencies/set_tax_residencies","metadata":{"seo":{"title":"Update tax residencies","description":"Update tax residencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"set_tax_residencies","name":"Update tax residencies","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1tax_residencies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tax residencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update tax residencies"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_932","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one","paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"]}},"schemaId":"schema_932","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one","paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/tax_residencies","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_932","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one","paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/tax_residencies","href":"tax-residencies/set_tax_residencies","openApiOperationId":"set_tax_residencies","summary":"Update tax residencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_932","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one","paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_932","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one","paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User tax residencies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1tax_residencies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-residencies/set_tax_residencies"}],"panels":[]}]},"httpPath":"/users/{user_id}/tax_residencies"}],"content":{"contentType":"group","meta":{"name":"Tax Residencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Residencies","showPageActions":true},{"nodeType":"markdoc","content":"All tax residencies related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/tax_residencies","summary":"Retrieve tax residencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-residencies/retrieve_tax_residencies","deprecated":false},{"title":"/users/{user_id}/tax_residencies","summary":"Update tax residencies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-residencies/set_tax_residencies","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account Management","content":null},{"type":"group","label":"Accounts","link":"/api/accounts","routeSlug":"/api/accounts","items":[{"label":"Get user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/list_user_accounts","routeSlug":"/api/accounts/list_user_accounts","metadata":{"seo":{"title":"Get user accounts","description":"Lists the accounts of a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_accounts","name":"Get user accounts","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the accounts of a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/accounts","href":"accounts/list_user_accounts","openApiOperationId":"list_user_accounts","summary":"Get user accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_933","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_933","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_933","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_933","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/list_user_accounts"}],"panels":[]}]},"httpPath":"/users/{user_id}/accounts"},{"label":"Get account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/retrieve_account","routeSlug":"/api/accounts/retrieve_account","metadata":{"seo":{"title":"Get account by ID","description":"Returns the account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account","name":"Get account by ID","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}","href":"accounts/retrieve_account","openApiOperationId":"retrieve_account","summary":"Get account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_935","exampleIds":["paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account"]}},"schemaId":"schema_935","exampleIds":["paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_935","exampleIds":["paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_935","exampleIds":["paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/retrieve_account"}],"panels":[]}]},"httpPath":"/accounts/{account_id}"},{"label":"Update account by ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/update_account","routeSlug":"/api/accounts/update_account","metadata":{"seo":{"title":"Update account by ID","description":"Updates the account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_account","name":"Update account by ID","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_936","exampleIds":["paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_936","exampleIds":["paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{account_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/accounts/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_936","exampleIds":["paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}","href":"accounts/update_account","openApiOperationId":"update_account","summary":"Update account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_936","exampleIds":["paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_936","exampleIds":["paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_937","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account"]}},"schemaId":"schema_937","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_937","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_937","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account","paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/update_account"}],"panels":[]}]},"httpPath":"/accounts/{account_id}"},{"label":"Close account by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/account_closure","routeSlug":"/api/accounts/account_closure","metadata":{"seo":{"title":"Close account by ID","description":"Initiates the closure request for an account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_closure","name":"Close account by ID","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates the closure request for an account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accounts/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:admin"]}],"responseCodes":["202","401","403","404","406","409","429","500","503","504"],"pointer":"/accounts/{account_id}","href":"accounts/account_closure","openApiOperationId":"account_closure","summary":"Close account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/account_closure"}],"panels":[]}]},"httpPath":"/accounts/{account_id}"},{"label":"Get accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/list_accounts","routeSlug":"/api/accounts/list_accounts","metadata":{"seo":{"title":"Get accounts","description":"Returns a list of all accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_accounts","name":"Get accounts","isWebhook":false,"pointer":"/paths/~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at§"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/accounts","href":"accounts/list_accounts","openApiOperationId":"list_accounts","summary":"Get accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account"]}},"schemaId":"schema_938","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_938","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/examples/User Account","paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/list_accounts"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/create_account","routeSlug":"/api/accounts/create_account","metadata":{"seo":{"title":"Create an account","description":"Creates an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_account","name":"Create an account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/User Account","paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"]}},"schemaId":"schema_939","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/User Account","paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"],"pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/User Account","paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts","href":"accounts/create_account","openApiOperationId":"create_account","summary":"Create an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_939","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/User Account","paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/User Account","paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/User Account","paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account"]}},"schemaId":"schema_940","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/User Account","paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_940","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/User Account","paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/User Account","paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/create_account"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Get business accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/list_business_accounts","routeSlug":"/api/accounts/list_business_accounts","metadata":{"seo":{"title":"Get business accounts","description":"Lists the accounts of a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_accounts","name":"Get business accounts","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get business accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the accounts of a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/accounts","href":"accounts/list_business_accounts","openApiOperationId":"list_business_accounts","summary":"Get business accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_941","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_941","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/list_business_accounts"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/accounts"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/accounts/account_event","routeSlug":"/api/accounts/account_event","metadata":{"seo":{"title":"Account events","description":"Account events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_event","name":"Account events","isWebhook":true,"pointer":"/paths/Account events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/Account events/post/requestBody/content/application~1json/examples/User Account","paths/Account events/post/requestBody/content/application~1json/examples/Business Account"]}},"schemaId":"schema_942","exampleIds":["paths/Account events/post/requestBody/content/application~1json/examples/User Account","paths/Account events/post/requestBody/content/application~1json/examples/Business Account"],"pointer":"/paths/Account events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/Account events/post/requestBody/content/application~1json/examples/User Account","paths/Account events/post/requestBody/content/application~1json/examples/Business Account"]}},"responseCodes":["200"],"pointer":"Account events","href":"accounts/account_event","openApiOperationId":"account_event","summary":"Account events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_942","exampleIds":["paths/Account events/post/requestBody/content/application~1json/examples/User Account","paths/Account events/post/requestBody/content/application~1json/examples/Business Account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/Account events/post/requestBody/content/application~1json/examples/User Account","paths/Account events/post/requestBody/content/application~1json/examples/Business Account"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/account_event"}],"panels":[]}]},"httpPath":"Account events"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":"All accounts related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/accounts","summary":"Get user accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/list_user_accounts","deprecated":false},{"title":"/accounts/{account_id}","summary":"Get account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/retrieve_account","deprecated":false},{"title":"/accounts/{account_id}","summary":"Update account by ID","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/accounts/update_account","deprecated":false},{"title":"/accounts/{account_id}","summary":"Close account by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounts/account_closure","deprecated":false},{"title":"/accounts","summary":"Get accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/list_accounts","deprecated":false},{"title":"/accounts","summary":"Create an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/create_account","deprecated":false},{"title":"/businesses/{business_id}/accounts","summary":"Get business accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/list_business_accounts","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account events","summary":"Account events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/account_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Groups","link":"/api/account-groups","routeSlug":"/api/account-groups","items":[{"label":"Get user account groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/list_user_account_groups","routeSlug":"/api/account-groups/list_user_account_groups","metadata":{"seo":{"title":"Get user account groups","description":"Lists the account groups of a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_account_groups","name":"Get user account groups","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1account_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user account groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the account groups of a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1account_groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1account_groups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1account_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/account_groups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/account_groups","href":"account-groups/list_user_account_groups","openApiOperationId":"list_user_account_groups","summary":"Get user account groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_943","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1account_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_943","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/list_user_account_groups"}],"panels":[]}]},"httpPath":"/users/{user_id}/account_groups"},{"label":"Get an account group by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/retrieve_account_group","routeSlug":"/api/account-groups/retrieve_account_group","metadata":{"seo":{"title":"Get an account group by ID","description":"Returns the account group specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account_group","name":"Get an account group by ID","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an account group by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the account group specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}","href":"account-groups/retrieve_account_group","openApiOperationId":"retrieve_account_group","summary":"Get an account group by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group"]}},"schemaId":"schema_945","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_945","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/retrieve_account_group"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}"},{"label":"Close an account group by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/account_group_closure","routeSlug":"/api/account-groups/account_group_closure","metadata":{"seo":{"title":"Close an account group by ID","description":"Initiates the closure request for an account group specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_group_closure","name":"Close an account group by ID","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close an account group by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates the closure request for an account group specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"closure_reason","in":"query","schemaId":"schema_946","description":"Records the reason for the account group closure."},{"name":"notification_only","in":"query","schemaId":"schema_947","description":"Indicates whether the request notifies of an intended future closing."}],"pointer":"/paths/~1account_groups~1{account_group_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account_groups/{account_group_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"closure_reason","in":"query","required":false,"schemaId":"schema_946"},{"name":"notification_only","in":"query","required":false,"schemaId":"schema_947"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:admin"]}],"responseCodes":["202","400","401","403","404","406","409","429","500","503","504"],"pointer":"/account_groups/{account_group_id}","href":"account-groups/account_group_closure","openApiOperationId":"account_group_closure","summary":"Close an account group by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/account_group_closure"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}"},{"label":"Get account groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/list_account_groups","routeSlug":"/api/account-groups/list_account_groups","metadata":{"seo":{"title":"Get account groups","description":"Returns a list of all account groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_groups","name":"Get account groups","isWebhook":false,"pointer":"/paths/~1account_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all account groups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/account_groups","href":"account-groups/list_account_groups","openApiOperationId":"list_account_groups","summary":"Get account groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group"]}},"schemaId":"schema_948","exampleIds":["paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_948","exampleIds":["paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/list_account_groups"}],"panels":[]}]},"httpPath":"/account_groups"},{"label":"Create an account group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/create_account_group","routeSlug":"/api/account-groups/create_account_group","metadata":{"seo":{"title":"Create an account group","description":"Creates an account group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_account_group","name":"Create an account group","isWebhook":false,"pointer":"/paths/~1account_groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_949","exampleIds":["paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group","paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"]}},"schemaId":"schema_949","exampleIds":["paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group","paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"],"pointer":"/paths/~1account_groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_groups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_949","exampleIds":["paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group","paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups","href":"account-groups/create_account_group","openApiOperationId":"create_account_group","summary":"Create an account group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_949","exampleIds":["paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group","paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_949","exampleIds":["paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group","paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account group created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_950","exampleIds":["paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group"]}},"schemaId":"schema_950","exampleIds":["paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_950","exampleIds":["paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_950","exampleIds":["paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group","paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/create_account_group"}],"panels":[]}]},"httpPath":"/account_groups"},{"label":"Get business account groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-groups/list_business_account_groups","routeSlug":"/api/account-groups/list_business_account_groups","metadata":{"seo":{"title":"Get business account groups","description":"Lists the account groups of a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_account_groups","name":"Get business account groups","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1account_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get business account groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the account groups of a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["accounts:read","accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1account_groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1account_groups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1account_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/account_groups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["accounts:read","accounts:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/account_groups","href":"account-groups/list_business_account_groups","openApiOperationId":"list_business_account_groups","summary":"Get business account groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_951","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_951","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1account_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_951","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_951","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/list_business_account_groups"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/account_groups"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account group events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/account-groups/account_group_event","routeSlug":"/api/account-groups/account_group_event","metadata":{"seo":{"title":"Account group events","description":"Account group events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_group_event","name":"Account group events","isWebhook":true,"pointer":"/paths/Account Group events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account group events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account group events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_952","exampleIds":["paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group","paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"]}},"schemaId":"schema_952","exampleIds":["paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group","paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"],"pointer":"/paths/Account Group events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account Group events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_952","exampleIds":["paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group","paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"]}},"responseCodes":["200"],"pointer":"Account Group events","href":"account-groups/account_group_event","openApiOperationId":"account_group_event","summary":"Account group events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_952","exampleIds":["paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group","paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_952","exampleIds":["paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group","paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account Group events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-groups/account_group_event"}],"panels":[]}]},"httpPath":"Account Group events"}],"content":{"contentType":"group","meta":{"name":"Account Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Groups","showPageActions":true},{"nodeType":"markdoc","content":"All account groups related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/account_groups","summary":"Get user account groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-groups/list_user_account_groups","deprecated":false},{"title":"/account_groups/{account_group_id}","summary":"Get an account group by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-groups/retrieve_account_group","deprecated":false},{"title":"/account_groups/{account_group_id}","summary":"Close an account group by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-groups/account_group_closure","deprecated":false},{"title":"/account_groups","summary":"Get account groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-groups/list_account_groups","deprecated":false},{"title":"/account_groups","summary":"Create an account group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-groups/create_account_group","deprecated":false},{"title":"/businesses/{business_id}/account_groups","summary":"Get business account groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-groups/list_business_account_groups","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account Group events","summary":"Account group events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-groups/account_group_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Corporate Actions","content":null},{"type":"group","label":"Corporate Actions","link":"/api/corporate-actions","routeSlug":"/api/corporate-actions","items":[{"label":"Corporate Action Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/corporate-actions/corporate_action_event","routeSlug":"/api/corporate-actions/corporate_action_event","metadata":{"seo":{"title":"Corporate Action Events","description":"Notifies tenants of corporate actions impacting securities holdings across all accounts within the organization. This webhook sends updates for dividends, stock splits, mergers, tender offers, and other events affecting positions at the organizational level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporate_action_event","name":"Corporate Action Events","isWebhook":true,"pointer":"/paths/Corporate Action Events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate Action Events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notifies tenants of corporate actions impacting securities holdings across \nall accounts within the organization. This webhook sends updates for dividends, \nstock splits, mergers, tender offers, and other events affecting positions at \nthe organizational level.\n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_953","exampleIds":["paths/Corporate Action Events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_953","exampleIds":["paths/Corporate Action Events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Corporate Action Events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Corporate Action Events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_953","exampleIds":["paths/Corporate Action Events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Corporate Action Events","href":"corporate-actions/corporate_action_event","openApiOperationId":"corporate_action_event","summary":"Corporate Action Events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_953","exampleIds":["paths/Corporate Action Events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_953","exampleIds":["paths/Corporate Action Events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Corporate Action Events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporate-actions/corporate_action_event"}],"panels":[]}]},"httpPath":"Corporate Action Events"}],"content":{"contentType":"group","meta":{"name":"Corporate Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate Actions","showPageActions":true},{"nodeType":"markdoc","content":"All Corporate Action related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Corporate Action Events","summary":"Corporate Action Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporate-actions/corporate_action_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Tax Wrappers","content":null},{"type":"group","label":"Tax Wrappers","link":"/api/tax-wrappers","routeSlug":"/api/tax-wrappers","items":[{"label":"Create a tax wrapper for ISA account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-wrappers/create_isa_tax_wrapper","routeSlug":"/api/tax-wrappers/create_isa_tax_wrapper","metadata":{"seo":{"title":"Create a tax wrapper for ISA account","description":"Creates a tax wrapper for ISA account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_isa_tax_wrapper","name":"Create a tax wrapper for ISA account","isWebhook":false,"pointer":"/paths/~1isa~1wrappers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tax wrapper for ISA account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a tax wrapper for ISA account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1isa~1wrappers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_954","exampleIds":["paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_954","exampleIds":["paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1isa~1wrappers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/isa/wrappers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_954","exampleIds":["paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/isa/wrappers","href":"tax-wrappers/create_isa_tax_wrapper","openApiOperationId":"create_isa_tax_wrapper","summary":"Create a tax wrapper for ISA account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_954","exampleIds":["paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_954","exampleIds":["paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ISA tax wrapper created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1isa~1wrappers/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_955","exampleIds":["paths/~1isa~1wrappers/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1isa~1wrappers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_955","exampleIds":["paths/~1isa~1wrappers/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1isa~1wrappers/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-wrappers/create_isa_tax_wrapper"}],"panels":[]}]},"httpPath":"/isa/wrappers"},{"label":"Retrieve ISA allowances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-wrappers/retrieve_isa_allowances","routeSlug":"/api/tax-wrappers/retrieve_isa_allowances","metadata":{"seo":{"title":"Retrieve ISA allowances","description":"Retrieves ISA allowances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_isa_allowances","name":"Retrieve ISA allowances","isWebhook":false,"pointer":"/paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ISA allowances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves ISA allowances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tax_wrapper_id","in":"path","schemaId":"schema_956","description":"","required":true}],"pointer":"/paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tax_year","in":"query","schemaId":"schema_957","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter allowances by tax_year YYYY/YYYY"},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_958","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid_from"},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/isa/wrappers/{tax_wrapper_id}/allowances","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"tax_wrapper_id","in":"path","required":true,"schemaId":"schema_956"}],"query":[{"name":"tax_year","in":"query","required":false,"schemaId":"schema_957"},{"name":"sort","in":"query","required":false,"schemaId":"schema_958"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/isa/wrappers/{tax_wrapper_id}/allowances","href":"tax-wrappers/retrieve_isa_allowances","openApiOperationId":"retrieve_isa_allowances","summary":"Retrieve ISA allowances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_959","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_959","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-wrappers/retrieve_isa_allowances"}],"panels":[]}]},"httpPath":"/isa/wrappers/{tax_wrapper_id}/allowances"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"ISA Tax Wrappers events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tax-wrappers/isa_tax_wrappers_event","routeSlug":"/api/tax-wrappers/isa_tax_wrappers_event","metadata":{"seo":{"title":"ISA Tax Wrappers events","description":"ISA Tax Wrappers events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"isa_tax_wrappers_event","name":"ISA Tax Wrappers events","isWebhook":true,"pointer":"/paths/ISA tax wrapper events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ISA Tax Wrappers events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"ISA Tax Wrappers events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"]}},"schemaId":"schema_960","exampleIds":["paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"],"pointer":"/paths/ISA tax wrapper events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ISA tax wrapper events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"]}},"responseCodes":["200"],"pointer":"ISA tax wrapper events","href":"tax-wrappers/isa_tax_wrappers_event","openApiOperationId":"isa_tax_wrappers_event","summary":"ISA Tax Wrappers events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_960","exampleIds":["paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/ISA tax wrapper events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-wrappers/isa_tax_wrappers_event"}],"panels":[]}]},"httpPath":"ISA tax wrapper events"},{"label":"ISA Allowance events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tax-wrappers/isa_allowance_event","routeSlug":"/api/tax-wrappers/isa_allowance_event","metadata":{"seo":{"title":"ISA Allowance events","description":"ISA Allowance events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"isa_allowance_event","name":"ISA Allowance events","isWebhook":true,"pointer":"/paths/ISA allowance events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ISA Allowance events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"ISA Allowance events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"]}},"schemaId":"schema_961","exampleIds":["paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"],"pointer":"/paths/ISA allowance events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ISA allowance events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"]}},"responseCodes":["200"],"pointer":"ISA allowance events","href":"tax-wrappers/isa_allowance_event","openApiOperationId":"isa_allowance_event","summary":"ISA Allowance events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_961","exampleIds":["paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/ISA allowance events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-wrappers/isa_allowance_event"}],"panels":[]}]},"httpPath":"ISA allowance events"}],"content":{"contentType":"group","meta":{"name":"Tax Wrappers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Wrappers","showPageActions":true},{"nodeType":"markdoc","content":"All tax wrappers related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/isa/wrappers","summary":"Create a tax wrapper for ISA account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-wrappers/create_isa_tax_wrapper","deprecated":false},{"title":"/isa/wrappers/{tax_wrapper_id}/allowances","summary":"Retrieve ISA allowances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-wrappers/retrieve_isa_allowances","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"ISA tax wrapper events","summary":"ISA Tax Wrappers events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-wrappers/isa_tax_wrappers_event","deprecated":false},{"title":"ISA allowance events","summary":"ISA Allowance events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-wrappers/isa_allowance_event","deprecated":false}]}]}]}]}},{"type":"group","label":"ISA Transfers","link":"/api/isa-transfers","routeSlug":"/api/isa-transfers","items":[{"label":"Create ISA transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/isa-transfers/create_isa_transfer","routeSlug":"/api/isa-transfers/create_isa_transfer","metadata":{"seo":{"title":"Create ISA transfer","description":"Create ISA transfer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_isa_transfer","name":"Create ISA transfer","isWebhook":false,"pointer":"/paths/~1isa~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ISA transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create ISA transfer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["isa_transfers:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1isa~1transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1isa~1transfers/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_962","exampleIds":["paths/~1isa~1transfers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1isa~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/isa/transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["isa_transfers:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1isa~1transfers/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/isa/transfers","href":"isa-transfers/create_isa_transfer","openApiOperationId":"create_isa_transfer","summary":"Create ISA transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_962","exampleIds":["paths/~1isa~1transfers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1isa~1transfers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ISA Transfer created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_963","exampleIds":["paths/~1isa~1transfers/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_963","exampleIds":["paths/~1isa~1transfers/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1isa~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_963","exampleIds":["paths/~1isa~1transfers/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_963","exampleIds":["paths/~1isa~1transfers/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/isa-transfers/create_isa_transfer"}],"panels":[]}]},"httpPath":"/isa/transfers"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"ISA Transfers events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/isa-transfers/isa_transfer_event","routeSlug":"/api/isa-transfers/isa_transfer_event","metadata":{"seo":{"title":"ISA Transfers events","description":"ISA Transfers events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"isa_transfer_event","name":"ISA Transfers events","isWebhook":true,"pointer":"/paths/ISA Transfers events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ISA Transfers events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"ISA Transfers events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_964","exampleIds":["paths/ISA Transfers events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_964","exampleIds":["paths/ISA Transfers events/post/requestBody/content/application~1json/example"],"pointer":"/paths/ISA Transfers events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ISA Transfers events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_964","exampleIds":["paths/ISA Transfers events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"ISA Transfers events","href":"isa-transfers/isa_transfer_event","openApiOperationId":"isa_transfer_event","summary":"ISA Transfers events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_964","exampleIds":["paths/ISA Transfers events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_964","exampleIds":["paths/ISA Transfers events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/ISA Transfers events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/isa-transfers/isa_transfer_event"}],"panels":[]}]},"httpPath":"ISA Transfers events"}],"content":{"contentType":"group","meta":{"name":"ISA Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ISA Transfers","showPageActions":true},{"nodeType":"markdoc","content":"All ISA Transfers related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/isa/transfers","summary":"Create ISA transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/isa-transfers/create_isa_transfer","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"ISA Transfers events","summary":"ISA Transfers events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/isa-transfers/isa_transfer_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Taxes","content":null},{"type":"group","label":"Tax Exemptions","link":"/api/tax-exemptions","routeSlug":"/api/tax-exemptions","items":[{"label":"Create a tax exemption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-exemptions/create_tax_exemption","routeSlug":"/api/tax-exemptions/create_tax_exemption","metadata":{"seo":{"title":"Create a tax exemption","description":"Creates a tax exemption."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_tax_exemption","name":"Create a tax exemption","isWebhook":false,"pointer":"/paths/~1tax_exemptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tax exemption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a tax exemption."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1tax_exemptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_965","exampleIds":["paths/~1tax_exemptions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_965","exampleIds":["paths/~1tax_exemptions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1tax_exemptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tax_exemptions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_965","exampleIds":["paths/~1tax_exemptions/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/tax_exemptions","href":"tax-exemptions/create_tax_exemption","openApiOperationId":"create_tax_exemption","summary":"Create a tax exemption"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_965","exampleIds":["paths/~1tax_exemptions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_965","exampleIds":["paths/~1tax_exemptions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Creation request accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_966","exampleIds":["paths/~1tax_exemptions/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_966","exampleIds":["paths/~1tax_exemptions/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1tax_exemptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_966","exampleIds":["paths/~1tax_exemptions/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_966","exampleIds":["paths/~1tax_exemptions/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/create_tax_exemption"}],"panels":[]}]},"httpPath":"/tax_exemptions"},{"label":"Get a tax exemption by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-exemptions/retrieve_tax_exemption_by_id","routeSlug":"/api/tax-exemptions/retrieve_tax_exemption_by_id","metadata":{"seo":{"title":"Get a tax exemption by ID","description":"Returns the tax exemption specified by its ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_tax_exemption_by_id","name":"Get a tax exemption by ID","isWebhook":false,"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a tax exemption by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tax exemption specified by its ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tax_exemption_id","in":"path","schemaId":"schema_967","description":"","required":true}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tax_exemptions/{tax_exemption_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"tax_exemption_id","in":"path","required":true,"schemaId":"schema_967"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/tax_exemptions/{tax_exemption_id}","href":"tax-exemptions/retrieve_tax_exemption_by_id","openApiOperationId":"retrieve_tax_exemption_by_id","summary":"Get a tax exemption by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_968","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_968","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_968","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_968","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/retrieve_tax_exemption_by_id"}],"panels":[]}]},"httpPath":"/tax_exemptions/{tax_exemption_id}"},{"label":"Update a tax exemption","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-exemptions/update_tax_exemption","routeSlug":"/api/tax-exemptions/update_tax_exemption","metadata":{"seo":{"title":"Update a tax exemption","description":"Updates a tax exemption specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_tax_exemption","name":"Update a tax exemption","isWebhook":false,"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a tax exemption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a tax exemption specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tax_exemption_id","in":"path","schemaId":"schema_967","description":"","required":true}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_969","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tax_exemptions/{tax_exemption_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"tax_exemption_id","in":"path","required":true,"schemaId":"schema_967"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/tax_exemptions/{tax_exemption_id}","href":"tax-exemptions/update_tax_exemption","openApiOperationId":"update_tax_exemption","summary":"Update a tax exemption"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_969","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The tax exemption update is submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_970","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example"]}},"schemaId":"schema_970","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_970","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_970","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/update_tax_exemption"}],"panels":[]}]},"httpPath":"/tax_exemptions/{tax_exemption_id}"},{"label":"Delete a tax exemption","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-exemptions/delete_tax_exemption","routeSlug":"/api/tax-exemptions/delete_tax_exemption","metadata":{"seo":{"title":"Delete a tax exemption","description":"Deletes a tax exemption specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_tax_exemption","name":"Delete a tax exemption","isWebhook":false,"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tax exemption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a tax exemption specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tax_exemption_id","in":"path","schemaId":"schema_967","description":"","required":true}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tax_exemptions/{tax_exemption_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"tax_exemption_id","in":"path","required":true,"schemaId":"schema_967"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"responseCodes":["202","401","403","404","406","429","500","503","504"],"pointer":"/tax_exemptions/{tax_exemption_id}","href":"tax-exemptions/delete_tax_exemption","openApiOperationId":"delete_tax_exemption","summary":"Delete a tax exemption"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/delete_tax_exemption"}],"panels":[]}]},"httpPath":"/tax_exemptions/{tax_exemption_id}"},{"label":"List tax exemptions for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tax-exemptions/retrieve_tax_exemptions_for_user","routeSlug":"/api/tax-exemptions/retrieve_tax_exemptions_for_user","metadata":{"seo":{"title":"List tax exemptions for a user","description":"Returns the tax exemptions of the user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_tax_exemptions_for_user","name":"List tax exemptions for a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1tax_exemptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tax exemptions for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tax exemptions of the user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["taxes:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1tax_exemptions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_971","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1tax_exemptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1tax_exemptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/tax_exemptions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_971"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["taxes:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/users/{user_id}/tax_exemptions","href":"tax-exemptions/retrieve_tax_exemptions_for_user","openApiOperationId":"retrieve_tax_exemptions_for_user","summary":"List tax exemptions for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_972","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_972","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1tax_exemptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_972","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_972","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/retrieve_tax_exemptions_for_user"}],"panels":[]}]},"httpPath":"/users/{user_id}/tax_exemptions"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Tax Exemption Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tax-exemptions/tax_exemption_event","routeSlug":"/api/tax-exemptions/tax_exemption_event","metadata":{"seo":{"title":"Tax Exemption Events","description":"Tax Exemption Events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tax_exemption_event","name":"Tax Exemption Events","isWebhook":true,"pointer":"/paths/Tax exemption events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Exemption Events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tax Exemption Events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_973","exampleIds":["paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"schemaId":"schema_973","exampleIds":["paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"],"pointer":"/paths/Tax exemption events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Tax exemption events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_973","exampleIds":["paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"responseCodes":["200"],"pointer":"Tax exemption events","href":"tax-exemptions/tax_exemption_event","openApiOperationId":"tax_exemption_event","summary":"Tax Exemption Events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_973","exampleIds":["paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_973","exampleIds":["paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Tax exemption events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/tax_exemption_event"}],"panels":[]}]},"httpPath":"Tax exemption events"},{"label":"Tax Exemption Failure Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tax-exemptions/tax_exemption_failure_event","routeSlug":"/api/tax-exemptions/tax_exemption_failure_event","metadata":{"seo":{"title":"Tax Exemption Failure Events","description":"Tax Exemption Failure Events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tax_exemption_failure_event","name":"Tax Exemption Failure Events","isWebhook":true,"pointer":"/paths/Tax exemption failure events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Exemption Failure Events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tax Exemption Failure Events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_974","exampleIds":["paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"schemaId":"schema_974","exampleIds":["paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"],"pointer":"/paths/Tax exemption failure events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Tax exemption failure events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_974","exampleIds":["paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"responseCodes":["200"],"pointer":"Tax exemption failure events","href":"tax-exemptions/tax_exemption_failure_event","openApiOperationId":"tax_exemption_failure_event","summary":"Tax Exemption Failure Events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_974","exampleIds":["paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_974","exampleIds":["paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated","paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Tax exemption failure events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-exemptions/tax_exemption_failure_event"}],"panels":[]}]},"httpPath":"Tax exemption failure events"}],"content":{"contentType":"group","meta":{"name":"Tax Exemptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Exemptions","showPageActions":true},{"nodeType":"markdoc","content":"All tax exemptions related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tax_exemptions","summary":"Create a tax exemption","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-exemptions/create_tax_exemption","deprecated":false},{"title":"/tax_exemptions/{tax_exemption_id}","summary":"Get a tax exemption by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-exemptions/retrieve_tax_exemption_by_id","deprecated":false},{"title":"/tax_exemptions/{tax_exemption_id}","summary":"Update a tax exemption","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tax-exemptions/update_tax_exemption","deprecated":false},{"title":"/tax_exemptions/{tax_exemption_id}","summary":"Delete a tax exemption","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tax-exemptions/delete_tax_exemption","deprecated":false},{"title":"/users/{user_id}/tax_exemptions","summary":"List tax exemptions for a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-exemptions/retrieve_tax_exemptions_for_user","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Tax exemption events","summary":"Tax Exemption Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-exemptions/tax_exemption_event","deprecated":false},{"title":"Tax exemption failure events","summary":"Tax Exemption Failure Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-exemptions/tax_exemption_failure_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Collections","link":"/api/tax-collections","routeSlug":"/api/tax-collections","items":[{"label":"Tax Collection Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/tax-collections/tax_collection_event","routeSlug":"/api/tax-collections/tax_collection_event","metadata":{"seo":{"title":"Tax Collection Events","description":"Tax Collection Events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tax_collection_event","name":"Tax Collection Events","isWebhook":true,"pointer":"/paths/Tax collection events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Collection Events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tax Collection Events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_975","exampleIds":["paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"]}},"schemaId":"schema_975","exampleIds":["paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"],"pointer":"/paths/Tax collection events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Tax collection events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_975","exampleIds":["paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"]}},"responseCodes":["200"],"pointer":"Tax collection events","href":"tax-collections/tax_collection_event","openApiOperationId":"tax_collection_event","summary":"Tax Collection Events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_975","exampleIds":["paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_975","exampleIds":["paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised","paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Tax collection events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-collections/tax_collection_event"}],"panels":[]}]},"httpPath":"Tax collection events"}],"content":{"contentType":"group","meta":{"name":"Tax Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Collections","showPageActions":true},{"nodeType":"markdoc","content":"All tax collections related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Tax collection events","summary":"Tax Collection Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-collections/tax_collection_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Instruments & Price Data","content":null},{"type":"group","label":"Instruments","link":"/api/instruments","routeSlug":"/api/instruments","items":[{"label":"List instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/instruments/list_instruments","routeSlug":"/api/instruments/list_instruments","metadata":{"seo":{"title":"List instruments","description":"List instruments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_instruments","name":"List instruments","isWebhook":false,"pointer":"/paths/~1instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List instruments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["instruments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"trading_status","in":"query","schemaId":"schema_976","description":"Filters the list to only show instruments with a certain status (e.g. only instruments that can be currently traded).","example":"ACTIVE"},{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1instruments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instruments","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"trading_status","in":"query","required":false,"example":"ACTIVE","schemaId":"schema_976"},{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["instruments:read"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/instruments","href":"instruments/list_instruments","openApiOperationId":"list_instruments","summary":"List instruments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_977","exampleIds":["paths/~1instruments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_977","exampleIds":["paths/~1instruments/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_977","exampleIds":["paths/~1instruments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_977","exampleIds":["paths/~1instruments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruments/list_instruments"}],"panels":[]}]},"httpPath":"/instruments"},{"label":"Get instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/instruments/retrieve_instrument","routeSlug":"/api/instruments/retrieve_instrument","metadata":{"seo":{"title":"Get instrument","description":"Returns the instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_instrument","name":"Get instrument","isWebhook":false,"pointer":"/paths/~1instruments~1{instrument_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the instrument."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["instruments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument_id","in":"path","schemaId":"schema_978","required":true}],"pointer":"/paths/~1instruments~1{instrument_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1instruments~1{instrument_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instruments/{instrument_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"instrument_id","in":"path","required":true,"schemaId":"schema_978"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["instruments:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/instruments/{instrument_id}","href":"instruments/retrieve_instrument","openApiOperationId":"retrieve_instrument","summary":"Get instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_979","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_979","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1instruments~1{instrument_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_979","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_979","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruments/retrieve_instrument"}],"panels":[]}]},"httpPath":"/instruments/{instrument_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Instruments events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/instruments/instrument_event","routeSlug":"/api/instruments/instrument_event","metadata":{"seo":{"title":"Instruments events","description":"Instruments events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"instrument_event","name":"Instruments events","isWebhook":true,"pointer":"/paths/Instruments events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Instruments events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Instruments events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_980","exampleIds":["paths/Instruments events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_980","exampleIds":["paths/Instruments events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Instruments events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Instruments events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_980","exampleIds":["paths/Instruments events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Instruments events","href":"instruments/instrument_event","openApiOperationId":"instrument_event","summary":"Instruments events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_980","exampleIds":["paths/Instruments events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_980","exampleIds":["paths/Instruments events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Instruments events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruments/instrument_event"}],"panels":[]}]},"httpPath":"Instruments events"}],"content":{"contentType":"group","meta":{"name":"Instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Instruments","showPageActions":true},{"nodeType":"markdoc","content":"All instrument related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/instruments","summary":"List instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instruments/list_instruments","deprecated":false},{"title":"/instruments/{instrument_id}","summary":"Get instrument","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instruments/retrieve_instrument","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Instruments events","summary":"Instruments events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/instruments/instrument_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Price Data","link":"/api/price-data","routeSlug":"/api/price-data","items":[{"label":"Get instrument venues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/price-data/retrieve_instrument_venues","routeSlug":"/api/price-data/retrieve_instrument_venues","metadata":{"seo":{"title":"Get instrument venues","description":"The venues where the instrument is traded and for which the price data is available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_instrument_venues","name":"Get instrument venues","isWebhook":false,"pointer":"/paths/~1instruments~1{instrument_id}~1venues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument venues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The venues where the instrument is traded and for which the price data is available."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["prices:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument_id","in":"path","schemaId":"schema_978","required":true}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instruments/{instrument_id}/venues","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"instrument_id","in":"path","required":true,"schemaId":"schema_978"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["prices:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/instruments/{instrument_id}/venues","href":"price-data/retrieve_instrument_venues","openApiOperationId":"retrieve_instrument_venues","summary":"Get instrument venues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_981","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_981","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_981","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_981","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-data/retrieve_instrument_venues"}],"panels":[]}]},"httpPath":"/instruments/{instrument_id}/venues"},{"label":"Get instrument latest price","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/price-data/retrieve_instrument_latest_price","routeSlug":"/api/price-data/retrieve_instrument_latest_price","metadata":{"seo":{"title":"Get instrument latest price","description":"Returns the instrument's latest price as available at the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_instrument_latest_price","name":"Get instrument latest price","isWebhook":false,"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument latest price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the instrument's latest price as available at the specified venue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["prices:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument_id","in":"path","schemaId":"schema_978","required":true},{"name":"venue_id","in":"path","schemaId":"schema_982","required":true}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"price_quality","in":"query","schemaId":"schema_983"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instruments/{instrument_id}/venues/{venue_id}/prices/latest","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"instrument_id","in":"path","required":true,"schemaId":"schema_978"},{"name":"venue_id","in":"path","required":true,"schemaId":"schema_982"}],"query":[{"name":"price_quality","in":"query","required":false,"example":"HIGHEST_AVAILABLE","schemaId":"schema_983"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["prices:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/instruments/{instrument_id}/venues/{venue_id}/prices/latest","href":"price-data/retrieve_instrument_latest_price","openApiOperationId":"retrieve_instrument_latest_price","summary":"Get instrument latest price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_984","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_984","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_984","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_984","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-data/retrieve_instrument_latest_price"}],"panels":[]}]},"httpPath":"/instruments/{instrument_id}/venues/{venue_id}/prices/latest"},{"label":"Get instrument OHLC prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/price-data/retrieve_instrument_prices_ohlc","routeSlug":"/api/price-data/retrieve_instrument_prices_ohlc","metadata":{"seo":{"title":"Get instrument OHLC prices","description":"Returns OHLC prices for the instrument at the specified venue for the chosen time period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_instrument_prices_ohlc","name":"Get instrument OHLC prices","isWebhook":false,"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument OHLC prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns OHLC prices for the instrument at the specified venue for the chosen time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If requested interval is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the response also includes days with 0 volume. In these cases "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are empty ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. If requested interval is smaller than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the intervals with 0 volume are omitted from the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["prices:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument_id","in":"path","schemaId":"schema_978","required":true},{"name":"venue_id","in":"path","schemaId":"schema_982","required":true}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_985","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns OHLC prices from and including this datetime (UTC). If not specified, OHLC prices are returned from 30 days before the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Time part of the timestamp is optional."},"children":[]}]}]}],"example":"2023-11-01T10:30:00Z"},{"name":"end_date","in":"query","schemaId":"schema_985","description":"Returns OHLC prices from and including this datetime (UTC). If not specified, OHLC prices are returned up to yesterday. Time part of the timestamp is optional.","example":"2023-11-15T13:30:00Z"},{"name":"adjusted_for","in":"query","schemaId":"schema_986","description":"Indication of the desired data adjustment. Prices are adjusted for corporate actions such as cash dividends and stock splits. Does not apply if intraday prices are being requested.","example":"NONE"},{"name":"interval","in":"query","schemaId":"schema_987","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the maximum length of the interval each OHLC price tuple covers. If a price did not change subsequent price tuples are omitted. Allowed values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for daily prices or any positive integer followed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hour or minute, respectively. Requests are limited to a maximum of 1000 data points."},"children":[]}]}]}],"example":"4h"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"instrument_id","in":"path","required":true,"schemaId":"schema_978"},{"name":"venue_id","in":"path","required":true,"schemaId":"schema_982"}],"query":[{"name":"start_date","in":"query","required":false,"example":"2023-11-01T10:30:00Z","schemaId":"schema_985"},{"name":"end_date","in":"query","required":false,"example":"2023-11-15T13:30:00Z","schemaId":"schema_985"},{"name":"adjusted_for","in":"query","required":false,"example":"NONE","schemaId":"schema_986"},{"name":"interval","in":"query","required":false,"example":"4h","schemaId":"schema_987"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["prices:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc","href":"price-data/retrieve_instrument_prices_ohlc","openApiOperationId":"retrieve_instrument_prices_ohlc","summary":"Get instrument OHLC prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_988","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_988","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_988","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_988","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-data/retrieve_instrument_prices_ohlc"}],"panels":[]}]},"httpPath":"/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc"}],"content":{"contentType":"group","meta":{"name":"Price Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Price Data","showPageActions":true},{"nodeType":"markdoc","content":"All price data related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/instruments/{instrument_id}/venues","summary":"Get instrument venues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-data/retrieve_instrument_venues","deprecated":false},{"title":"/instruments/{instrument_id}/venues/{venue_id}/prices/latest","summary":"Get instrument latest price","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-data/retrieve_instrument_latest_price","deprecated":false},{"title":"/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc","summary":"Get instrument OHLC prices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-data/retrieve_instrument_prices_ohlc","deprecated":false}]}]}]}]}},{"type":"separator","label":"Orders","content":null},{"type":"group","label":"Orders","link":"/api/orders","routeSlug":"/api/orders","items":[{"label":"Get orders for an account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/orders/list_account_orders","routeSlug":"/api/orders/list_account_orders","metadata":{"seo":{"title":"Get orders for an account by ID","description":"Returns a list of all orders for the account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_orders","name":"Get orders for an account by ID","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orders for an account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all orders for the account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["orders:read","orders:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"account_group_id","in":"query","schemaId":"schema_944"},{"name":"user_id","in":"query","schemaId":"schema_895"},{"name":"status","in":"query","schemaId":"schema_989","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}]},{"name":"date_created_from","in":"query","schemaId":"schema_990","description":"date range from","example":"2022-10-14T10:10:10Z"},{"name":"date_created_to","in":"query","schemaId":"schema_990","description":"date range to","example":"2022-10-14T10:10:10Z"},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1{account_id}~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/orders","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"account_group_id","in":"query","required":false,"schemaId":"schema_944"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_895"},{"name":"status","in":"query","required":false,"schemaId":"schema_989"},{"name":"date_created_from","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_990"},{"name":"date_created_to","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_990"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["orders:read","orders:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/orders","href":"orders/list_account_orders","openApiOperationId":"list_account_orders","summary":"Get orders for an account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_991","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_991","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_991","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_991","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/list_account_orders"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/orders"},{"label":"Place an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/orders/place_order","routeSlug":"/api/orders/place_order","metadata":{"seo":{"title":"Place an order","description":"Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"place_order","name":"Place an order","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Place an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["orders:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_992","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"]}},"schemaId":"schema_992","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"],"pointer":"/paths/~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["orders:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_992","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"]}},"responseCodes":["202","400","401","403","406","422","429","500","503","504"],"pointer":"/orders","href":"orders/place_order","openApiOperationId":"place_order","summary":"Place an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_992","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_992","exampleIds":["paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request for the order creation has been accepted for processing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions"]}},"schemaId":"schema_993","exampleIds":["paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_993","exampleIds":["paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model","paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/406/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/place_order"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Get an order by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/orders/retrieve_order","routeSlug":"/api/orders/retrieve_order","metadata":{"seo":{"title":"Get an order by ID","description":"Returns the order specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_order","name":"Get an order by ID","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an order by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the order specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["orders:read","orders:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_994","description":"","required":true}],"pointer":"/paths/~1orders~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1orders~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{order_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_994"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["orders:read","orders:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/orders/{order_id}","href":"orders/retrieve_order","openApiOperationId":"retrieve_order","summary":"Get an order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_993","exampleIds":["paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1orders~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_993","exampleIds":["paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retrieve_order"}],"panels":[]}]},"httpPath":"/orders/{order_id}"},{"label":"Cancel an order by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/orders/cancel_order","routeSlug":"/api/orders/cancel_order","metadata":{"seo":{"title":"Cancel an order by ID","description":"Cancels an order specified by its ID. It is possible to cancel an order in the NEW or PROCESSING status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_order","name":"Cancel an order by ID","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an order by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels an order specified by its ID. It is possible to cancel an order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["orders:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_994","description":"","required":true}],"pointer":"/paths/~1orders~1{order_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1orders~1{order_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/{order_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_994"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["orders:admin"]}],"responseCodes":["202","401","403","404","406","429","500","503","504"],"pointer":"/orders/{order_id}","href":"orders/cancel_order","openApiOperationId":"cancel_order","summary":"Cancel an order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The order cancelling request is accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_995","exampleIds":["paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example"]}},"schemaId":"schema_995","exampleIds":["paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1orders~1{order_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_995","exampleIds":["paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_995","exampleIds":["paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/cancel_order"}],"panels":[]}]},"httpPath":"/orders/{order_id}"},{"label":"Get an order execution by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/orders/retrieve_order_execution","routeSlug":"/api/orders/retrieve_order_execution","metadata":{"seo":{"title":"Get an order execution by ID","description":"Returns the order execution specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_order_execution","name":"Get an order execution by ID","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}~1executions~1{execution_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an order execution by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the order execution specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["orders:read","orders:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"execution_id","in":"path","schemaId":"schema_996","description":"","required":true},{"name":"order_id","in":"path","schemaId":"schema_994","description":"","required":true}],"pointer":"/paths/~1orders~1{order_id}~1executions~1{execution_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1orders~1{order_id}~1executions~1{execution_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{order_id}/executions/{execution_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"execution_id","in":"path","required":true,"schemaId":"schema_996"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_994"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["orders:read","orders:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/orders/{order_id}/executions/{execution_id}","href":"orders/retrieve_order_execution","openApiOperationId":"retrieve_order_execution","summary":"Get an order execution by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_997","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_997","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_997","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_997","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retrieve_order_execution"}],"panels":[]}]},"httpPath":"/orders/{order_id}/executions/{execution_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Orders events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/orders/order_event","routeSlug":"/api/orders/order_event","metadata":{"seo":{"title":"Orders events","description":"Orders events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_event","name":"Orders events","isWebhook":true,"pointer":"/paths/Orders events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Orders events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_998","exampleIds":["paths/Orders events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_998","exampleIds":["paths/Orders events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Orders events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Orders events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_998","exampleIds":["paths/Orders events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Orders events","href":"orders/order_event","openApiOperationId":"order_event","summary":"Orders events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_998","exampleIds":["paths/Orders events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_998","exampleIds":["paths/Orders events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Orders events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order_event"}],"panels":[]}]},"httpPath":"Orders events"},{"label":"Executions events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/orders/execution_event","routeSlug":"/api/orders/execution_event","metadata":{"seo":{"title":"Executions events","description":"Executions events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"execution_event","name":"Executions events","isWebhook":true,"pointer":"/paths/Executions events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Executions events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Executions events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_999","exampleIds":["paths/Executions events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_999","exampleIds":["paths/Executions events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Executions events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Executions events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_999","exampleIds":["paths/Executions events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Executions events","href":"orders/execution_event","openApiOperationId":"execution_event","summary":"Executions events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_999","exampleIds":["paths/Executions events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_999","exampleIds":["paths/Executions events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Executions events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/execution_event"}],"panels":[]}]},"httpPath":"Executions events"},{"label":"Order Cancellations events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/orders/order_cancellation_event","routeSlug":"/api/orders/order_cancellation_event","metadata":{"seo":{"title":"Order Cancellations events","description":"Order Cancellations events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_cancellation_event","name":"Order Cancellations events","isWebhook":true,"pointer":"/paths/Order Cancellations events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Cancellations events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Order Cancellations events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1000","exampleIds":["paths/Order Cancellations events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1000","exampleIds":["paths/Order Cancellations events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Order Cancellations events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Order Cancellations events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1000","exampleIds":["paths/Order Cancellations events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Order Cancellations events","href":"orders/order_cancellation_event","openApiOperationId":"order_cancellation_event","summary":"Order Cancellations events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1000","exampleIds":["paths/Order Cancellations events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1000","exampleIds":["paths/Order Cancellations events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Order Cancellations events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order_cancellation_event"}],"panels":[]}]},"httpPath":"Order Cancellations events"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"All order related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{account_id}/orders","summary":"Get orders for an account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/list_account_orders","deprecated":false},{"title":"/orders","summary":"Place an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/place_order","deprecated":false},{"title":"/orders/{order_id}","summary":"Get an order by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/retrieve_order","deprecated":false},{"title":"/orders/{order_id}","summary":"Cancel an order by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/cancel_order","deprecated":false},{"title":"/orders/{order_id}/executions/{execution_id}","summary":"Get an order execution by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/retrieve_order_execution","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Orders events","summary":"Orders events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order_event","deprecated":false},{"title":"Executions events","summary":"Executions events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/execution_event","deprecated":false},{"title":"Order Cancellations events","summary":"Order Cancellations events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order_cancellation_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Investment Solutions","content":null},{"type":"group","label":"Portfolios","link":"/api/portfolios","routeSlug":"/api/portfolios","items":[{"label":"List portfolios allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/list_portfolios_allocations","routeSlug":"/api/portfolios/list_portfolios_allocations","metadata":{"seo":{"title":"List portfolios allocations","description":"List portfolios allocations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_portfolios_allocations","name":"List portfolios allocations","isWebhook":false,"pointer":"/paths/~1portfolios~1allocations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List portfolios allocations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List portfolios allocations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio allocations with dates starting from and including this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio allocations with dates up until this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"instrument_ids","in":"query","schemaId":"schema_880","description":"Filters portfolio allocations containing the instruments ID's","example":"bf72bdc1-b342-494f-9739-b27ae9011b86,dcbe2cf4-4f37-4fe5-9393-4fb52bb87fab"}],"pointer":"/paths/~1portfolios~1allocations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1allocations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/allocations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1001"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"instrument_ids","in":"query","required":false,"example":"bf72bdc1-b342-494f-9739-b27ae9011b86,dcbe2cf4-4f37-4fe5-9393-4fb52bb87fab","schemaId":"schema_880"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/allocations","href":"portfolios/list_portfolios_allocations","openApiOperationId":"list_portfolios_allocations","summary":"List portfolios allocations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios allocations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1004","exampleIds":["paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1004","exampleIds":["paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1allocations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1004","exampleIds":["paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1004","exampleIds":["paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/list_portfolios_allocations"}],"panels":[]}]},"httpPath":"/portfolios/allocations"},{"label":"Create portfolios allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/create_portfolios_allocation","routeSlug":"/api/portfolios/create_portfolios_allocation","metadata":{"seo":{"title":"Create portfolios allocation","description":"Create portfolios allocation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_portfolios_allocation","name":"Create portfolios allocation","isWebhook":false,"pointer":"/paths/~1portfolios~1allocations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create portfolios allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create portfolios allocation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1allocations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1005","exampleIds":["paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1005","exampleIds":["paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1portfolios~1allocations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portfolios/allocations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1005","exampleIds":["paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/allocations","href":"portfolios/create_portfolios_allocation","openApiOperationId":"create_portfolios_allocation","summary":"Create portfolios allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1005","exampleIds":["paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1005","exampleIds":["paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios allocation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1allocations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/create_portfolios_allocation"}],"panels":[]}]},"httpPath":"/portfolios/allocations"},{"label":"Retrieve portfolios allocation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/retrieve_portfolios_allocation","routeSlug":"/api/portfolios/retrieve_portfolios_allocation","metadata":{"seo":{"title":"Retrieve portfolios allocation","description":"Retrieve portfolios allocation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_portfolios_allocation","name":"Retrieve portfolios allocation","isWebhook":false,"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve portfolios allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve portfolios allocation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"allocation_id","in":"path","schemaId":"schema_1007","required":true}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/allocations/{allocation_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"allocation_id","in":"path","required":true,"schemaId":"schema_1007"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/allocations/{allocation_id}","href":"portfolios/retrieve_portfolios_allocation","openApiOperationId":"retrieve_portfolios_allocation","summary":"Retrieve portfolios allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios allocation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/retrieve_portfolios_allocation"}],"panels":[]}]},"httpPath":"/portfolios/allocations/{allocation_id}"},{"label":"Update portfolios allocation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/update_portfolios_allocation","routeSlug":"/api/portfolios/update_portfolios_allocation","metadata":{"seo":{"title":"Update portfolios allocation","description":"Update portfolios allocation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_portfolios_allocation","name":"Update portfolios allocation","isWebhook":false,"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update portfolios allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update portfolios allocation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"allocation_id","in":"path","schemaId":"schema_1007","required":true}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1008","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary","paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"]}},"schemaId":"schema_1008","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary","paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/portfolios/allocations/{allocation_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"allocation_id","in":"path","required":true,"schemaId":"schema_1007"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1008","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary","paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/allocations/{allocation_id}","href":"portfolios/update_portfolios_allocation","openApiOperationId":"update_portfolios_allocation","summary":"Update portfolios allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1008","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary","paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1008","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary","paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios allocation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1006","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/update_portfolios_allocation"}],"panels":[]}]},"httpPath":"/portfolios/allocations/{allocation_id}"},{"label":"List portfolios configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/list_portfolios_configurations","routeSlug":"/api/portfolios/list_portfolios_configurations","metadata":{"seo":{"title":"List portfolios configurations","description":"List portfolios configurations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_portfolios_configurations","name":"List portfolios configurations","isWebhook":false,"pointer":"/paths/~1portfolios~1configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List portfolios configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List portfolios configurations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1009","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio configurations with dates starting from and including this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio configurations with dates up until this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"account_id","in":"query","schemaId":"schema_880","description":"Filters portfolio configurations by account ID","example":"3ada8e9e-82c4-4c78-a43d-a691b1636509"},{"name":"allocation_id","in":"query","schemaId":"schema_880","description":"Filters portfolio configurations by allocation ID","example":"f6c2b02a-3214-4a40-82ae-6c76df50bc8c"}],"pointer":"/paths/~1portfolios~1configurations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1configurations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/configurations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1009"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"account_id","in":"query","required":false,"example":"3ada8e9e-82c4-4c78-a43d-a691b1636509","schemaId":"schema_880"},{"name":"allocation_id","in":"query","required":false,"example":"f6c2b02a-3214-4a40-82ae-6c76df50bc8c","schemaId":"schema_880"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/configurations","href":"portfolios/list_portfolios_configurations","openApiOperationId":"list_portfolios_configurations","summary":"List portfolios configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios configurations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1010","exampleIds":["paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1010","exampleIds":["paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1configurations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1010","exampleIds":["paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1010","exampleIds":["paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/list_portfolios_configurations"}],"panels":[]}]},"httpPath":"/portfolios/configurations"},{"label":"Create portfolios configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/create_portfolios_configuration","routeSlug":"/api/portfolios/create_portfolios_configuration","metadata":{"seo":{"title":"Create portfolios configuration","description":"Create portfolios configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_portfolios_configuration","name":"Create portfolios configuration","isWebhook":false,"pointer":"/paths/~1portfolios~1configurations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create portfolios configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create portfolios configuration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1configurations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1011","exampleIds":["paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1011","exampleIds":["paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1portfolios~1configurations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portfolios/configurations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1011","exampleIds":["paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","422","429","500","503","504"],"pointer":"/portfolios/configurations","href":"portfolios/create_portfolios_configuration","openApiOperationId":"create_portfolios_configuration","summary":"Create portfolios configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1011","exampleIds":["paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1011","exampleIds":["paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1configurations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/create_portfolios_configuration"}],"panels":[]}]},"httpPath":"/portfolios/configurations"},{"label":"Retrieve portfolios configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/retrieve_portfolios_configuration","routeSlug":"/api/portfolios/retrieve_portfolios_configuration","metadata":{"seo":{"title":"Retrieve portfolios configuration","description":"Retrieve portfolios configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_portfolios_configuration","name":"Retrieve portfolios configuration","isWebhook":false,"pointer":"/paths/~1portfolios~1configurations~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve portfolios configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve portfolios configuration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/configurations/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/configurations/{account_id}","href":"portfolios/retrieve_portfolios_configuration","openApiOperationId":"retrieve_portfolios_configuration","summary":"Retrieve portfolios configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/retrieve_portfolios_configuration"}],"panels":[]}]},"httpPath":"/portfolios/configurations/{account_id}"},{"label":"Update portfolios configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/update_portfolios_configuration","routeSlug":"/api/portfolios/update_portfolios_configuration","metadata":{"seo":{"title":"Update portfolios configuration","description":"Update portfolios configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_portfolios_configuration","name":"Update portfolios configuration","isWebhook":false,"pointer":"/paths/~1portfolios~1configurations~1{account_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update portfolios configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update portfolios configuration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1013","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_1013","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/portfolios/configurations/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1013","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/configurations/{account_id}","href":"portfolios/update_portfolios_configuration","openApiOperationId":"update_portfolios_configuration","summary":"Update portfolios configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1013","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1013","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolio","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1012","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/update_portfolios_configuration"}],"panels":[]}]},"httpPath":"/portfolios/configurations/{account_id}"},{"label":"Delete portfolios configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/delete_portfolios_configuration","routeSlug":"/api/portfolios/delete_portfolios_configuration","metadata":{"seo":{"title":"Delete portfolios configuration","description":"Delete portfolios configuration (hard delete)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_portfolios_configuration","name":"Delete portfolios configuration","isWebhook":false,"pointer":"/paths/~1portfolios~1configurations~1{account_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete portfolios configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete portfolios configuration (hard delete)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/portfolios/configurations/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"responseCodes":["204","401","403","404","429","500","503","504"],"pointer":"/portfolios/configurations/{account_id}","href":"portfolios/delete_portfolios_configuration","openApiOperationId":"delete_portfolios_configuration","summary":"Delete portfolios configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1configurations~1{account_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/delete_portfolios_configuration"}],"panels":[]}]},"httpPath":"/portfolios/configurations/{account_id}"},{"label":"List portfolios orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/list_portfolios_orders","routeSlug":"/api/portfolios/list_portfolios_orders","metadata":{"seo":{"title":"List portfolios orders","description":"List portfolios orders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_portfolios_orders","name":"List portfolios orders","isWebhook":false,"pointer":"/paths/~1portfolios~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List portfolios orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List portfolios orders"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio orders with dates starting from and including this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns portfolio orders with dates up until this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"allocation_id","in":"query","schemaId":"schema_1007","description":"Filters portfolio orders containing the allocation id","example":"f96eaefd-b4c6-477a-9bbe-c744bf26172f"},{"name":"account_id","in":"query","schemaId":"schema_934","description":"Filters portfolio orders containing the account id","example":"2c865aab-6737-4b0e-9154-69a4622b2727"}],"pointer":"/paths/~1portfolios~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/orders","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1001"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"allocation_id","in":"query","required":false,"example":"f96eaefd-b4c6-477a-9bbe-c744bf26172f","schemaId":"schema_1007"},{"name":"account_id","in":"query","required":false,"example":"2c865aab-6737-4b0e-9154-69a4622b2727","schemaId":"schema_934"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/orders","href":"portfolios/list_portfolios_orders","openApiOperationId":"list_portfolios_orders","summary":"List portfolios orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios orders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1014","exampleIds":["paths/~1portfolios~1orders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1014","exampleIds":["paths/~1portfolios~1orders/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1014","exampleIds":["paths/~1portfolios~1orders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1014","exampleIds":["paths/~1portfolios~1orders/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/list_portfolios_orders"}],"panels":[]}]},"httpPath":"/portfolios/orders"},{"label":"Create portfolios order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/create_portfolios_order","routeSlug":"/api/portfolios/create_portfolios_order","metadata":{"seo":{"title":"Create portfolios order","description":"Create portfolios order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_portfolios_order","name":"Create portfolios order","isWebhook":false,"pointer":"/paths/~1portfolios~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create portfolios order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create portfolios order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1015","exampleIds":["paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy","paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"]}},"schemaId":"schema_1015","exampleIds":["paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy","paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"],"pointer":"/paths/~1portfolios~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portfolios/orders","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1015","exampleIds":["paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy","paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/orders","href":"portfolios/create_portfolios_order","openApiOperationId":"create_portfolios_order","summary":"Create portfolios order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1015","exampleIds":["paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy","paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1015","exampleIds":["paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy","paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/create_portfolios_order"}],"panels":[]}]},"httpPath":"/portfolios/orders"},{"label":"Retrieve portfolios order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/retrieve_portfolios_order","routeSlug":"/api/portfolios/retrieve_portfolios_order","metadata":{"seo":{"title":"Retrieve portfolios order","description":"Retrieve portfolios order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_portfolios_order","name":"Retrieve portfolios order","isWebhook":false,"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve portfolios order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve portfolios order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolio_order_id","in":"path","schemaId":"schema_1017","required":true}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/orders/{portfolio_order_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"portfolio_order_id","in":"path","required":true,"schemaId":"schema_1017"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/orders/{portfolio_order_id}","href":"portfolios/retrieve_portfolios_order","openApiOperationId":"retrieve_portfolios_order","summary":"Retrieve portfolios order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled"]}},"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1016","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing","paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/retrieve_portfolios_order"}],"panels":[]}]},"httpPath":"/portfolios/orders/{portfolio_order_id}"},{"label":"Cancel portfolios order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/cancel_portfolios_order","routeSlug":"/api/portfolios/cancel_portfolios_order","metadata":{"seo":{"title":"Cancel portfolios order","description":"Cancel portfolios order. Cancellations may not be possible - in rare situations, some individual orders within portfolios order may already have been filled. In this case, cancellation could result in a mix of cancelled and filled orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_portfolios_order","name":"Cancel portfolios order","isWebhook":false,"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel portfolios order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel portfolios order. Cancellations may not be possible - in rare situations, some individual orders within portfolios order may already have been filled. In this case, cancellation could result in a mix of cancelled and filled orders."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolio_order_id","in":"path","schemaId":"schema_1017","required":true}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/portfolios/orders/{portfolio_order_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"portfolio_order_id","in":"path","required":true,"schemaId":"schema_1017"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"responseCodes":["202","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/orders/{portfolio_order_id}","href":"portfolios/cancel_portfolios_order","openApiOperationId":"cancel_portfolios_order","summary":"Cancel portfolios order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/cancel_portfolios_order"}],"panels":[]}]},"httpPath":"/portfolios/orders/{portfolio_order_id}"},{"label":"List portfolios allocation accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios/list_portfolios_allocation_accounts","routeSlug":"/api/portfolios/list_portfolios_allocation_accounts","metadata":{"seo":{"title":"List portfolios allocation accounts","description":"List portfolios allocation accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_portfolios_allocation_accounts","name":"List portfolios allocation accounts","isWebhook":false,"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List portfolios allocation accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List portfolios allocation accounts"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"allocation_id","in":"path","schemaId":"schema_1007","required":true}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/allocations/{allocation_id}/accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"allocation_id","in":"path","required":true,"schemaId":"schema_1007"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1001"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/allocations/{allocation_id}/accounts","href":"portfolios/list_portfolios_allocation_accounts","openApiOperationId":"list_portfolios_allocation_accounts","summary":"List portfolios allocation accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios allocation accounts","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1018","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1018","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1018","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1018","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/list_portfolios_allocation_accounts"}],"panels":[]}]},"httpPath":"/portfolios/allocations/{allocation_id}/accounts"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Portfolios orders events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/portfolios/portfolio_order_event","routeSlug":"/api/portfolios/portfolio_order_event","metadata":{"seo":{"title":"Portfolios orders events","description":"Portfolios orders events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolio_order_event","name":"Portfolios orders events","isWebhook":true,"pointer":"/paths/Portfolio orders events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolios orders events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Portfolios orders events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1019","exampleIds":["paths/Portfolio orders events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1019","exampleIds":["paths/Portfolio orders events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Portfolio orders events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Portfolio orders events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1019","exampleIds":["paths/Portfolio orders events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Portfolio orders events","href":"portfolios/portfolio_order_event","openApiOperationId":"portfolio_order_event","summary":"Portfolios orders events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1019","exampleIds":["paths/Portfolio orders events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1019","exampleIds":["paths/Portfolio orders events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Portfolio orders events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/portfolio_order_event"}],"panels":[]}]},"httpPath":"Portfolio orders events"},{"label":"Portfolios allocations events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/portfolios/portfolio_allocation_event","routeSlug":"/api/portfolios/portfolio_allocation_event","metadata":{"seo":{"title":"Portfolios allocations events","description":"Portfolios allocations events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolio_allocation_event","name":"Portfolios allocations events","isWebhook":true,"pointer":"/paths/Portfolio allocations events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolios allocations events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Portfolios allocations events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1020","exampleIds":["paths/Portfolio allocations events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1020","exampleIds":["paths/Portfolio allocations events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Portfolio allocations events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Portfolio allocations events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1020","exampleIds":["paths/Portfolio allocations events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Portfolio allocations events","href":"portfolios/portfolio_allocation_event","openApiOperationId":"portfolio_allocation_event","summary":"Portfolios allocations events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1020","exampleIds":["paths/Portfolio allocations events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1020","exampleIds":["paths/Portfolio allocations events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Portfolio allocations events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios/portfolio_allocation_event"}],"panels":[]}]},"httpPath":"Portfolio allocations events"}],"content":{"contentType":"group","meta":{"name":"Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolios","showPageActions":true},{"nodeType":"markdoc","content":"All portfolios related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/portfolios/allocations","summary":"List portfolios allocations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/list_portfolios_allocations","deprecated":false},{"title":"/portfolios/allocations","summary":"Create portfolios allocation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios/create_portfolios_allocation","deprecated":false},{"title":"/portfolios/allocations/{allocation_id}","summary":"Retrieve portfolios allocation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/retrieve_portfolios_allocation","deprecated":false},{"title":"/portfolios/allocations/{allocation_id}","summary":"Update portfolios allocation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/portfolios/update_portfolios_allocation","deprecated":false},{"title":"/portfolios/configurations","summary":"List portfolios configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/list_portfolios_configurations","deprecated":false},{"title":"/portfolios/configurations","summary":"Create portfolios configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios/create_portfolios_configuration","deprecated":false},{"title":"/portfolios/configurations/{account_id}","summary":"Retrieve portfolios configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/retrieve_portfolios_configuration","deprecated":false},{"title":"/portfolios/configurations/{account_id}","summary":"Update portfolios configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/portfolios/update_portfolios_configuration","deprecated":false},{"title":"/portfolios/configurations/{account_id}","summary":"Delete portfolios configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/portfolios/delete_portfolios_configuration","deprecated":false},{"title":"/portfolios/orders","summary":"List portfolios orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/list_portfolios_orders","deprecated":false},{"title":"/portfolios/orders","summary":"Create portfolios order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios/create_portfolios_order","deprecated":false},{"title":"/portfolios/orders/{portfolio_order_id}","summary":"Retrieve portfolios order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/retrieve_portfolios_order","deprecated":false},{"title":"/portfolios/orders/{portfolio_order_id}","summary":"Cancel portfolios order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/portfolios/cancel_portfolios_order","deprecated":false},{"title":"/portfolios/allocations/{allocation_id}/accounts","summary":"List portfolios allocation accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios/list_portfolios_allocation_accounts","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Portfolio orders events","summary":"Portfolios orders events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios/portfolio_order_event","deprecated":false},{"title":"Portfolio allocations events","summary":"Portfolios allocations events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios/portfolio_allocation_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Portfolios Rebalancing","link":"/api/portfolios-rebalancing","routeSlug":"/api/portfolios-rebalancing","items":[{"label":"Trigger portfolio rebalancing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios-rebalancing/trigger_portfolio_rebalancing","routeSlug":"/api/portfolios-rebalancing/trigger_portfolio_rebalancing","metadata":{"seo":{"title":"Trigger portfolio rebalancing","description":"Trigger portfolio rebalancing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trigger_portfolio_rebalancing","name":"Trigger portfolio rebalancing","isWebhook":false,"pointer":"/paths/~1portfolios~1rebalancings~1executions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger portfolio rebalancing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger portfolio rebalancing"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1021","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts","paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"]}},"schemaId":"schema_1021","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts","paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"],"pointer":"/paths/~1portfolios~1rebalancings~1executions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portfolios/rebalancings/executions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1021","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts","paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/portfolios/rebalancings/executions","href":"portfolios-rebalancing/trigger_portfolio_rebalancing","openApiOperationId":"trigger_portfolio_rebalancing","summary":"Trigger portfolio rebalancing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1021","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts","paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1021","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts","paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolio","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1022","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1022","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1022","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1022","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios-rebalancing/trigger_portfolio_rebalancing"}],"panels":[]}]},"httpPath":"/portfolios/rebalancings/executions"},{"label":"Retrieve portfolios rebalancing execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios-rebalancing/retrieve_portfolios_rebalancing_execution","routeSlug":"/api/portfolios-rebalancing/retrieve_portfolios_rebalancing_execution","metadata":{"seo":{"title":"Retrieve portfolios rebalancing execution","description":"Retrieve portfolios rebalancing execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_portfolios_rebalancing_execution","name":"Retrieve portfolios rebalancing execution","isWebhook":false,"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve portfolios rebalancing execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve portfolios rebalancing execution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"execution_id","in":"path","schemaId":"schema_996","description":"","required":true}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/rebalancings/executions/{execution_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"execution_id","in":"path","required":true,"schemaId":"schema_996"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/rebalancings/executions/{execution_id}","href":"portfolios-rebalancing/retrieve_portfolios_rebalancing_execution","openApiOperationId":"retrieve_portfolios_rebalancing_execution","summary":"Retrieve portfolios rebalancing execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1023","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1023","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1023","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1023","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios-rebalancing/retrieve_portfolios_rebalancing_execution"}],"panels":[]}]},"httpPath":"/portfolios/rebalancings/executions/{execution_id}"},{"label":"List portfolio rebalancing execution orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/portfolios-rebalancing/list_portfolio_rebalancing_execution_orders","routeSlug":"/api/portfolios-rebalancing/list_portfolio_rebalancing_execution_orders","metadata":{"seo":{"title":"List portfolio rebalancing execution orders","description":"List portfolio rebalancing execution orders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_portfolio_rebalancing_execution_orders","name":"List portfolio rebalancing execution orders","isWebhook":false,"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List portfolio rebalancing execution orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List portfolio rebalancing execution orders"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["portfolios:read","portfolios:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"execution_id","in":"path","schemaId":"schema_996","description":"","required":true}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1024","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns rebalancing orders with dates starting from and including this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns rebalancing orders with dates up until this date (UTC)","example":"2022-10-14T10:10:10Z"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portfolios/rebalancings/executions/{execution_id}/orders","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"execution_id","in":"path","required":true,"schemaId":"schema_996"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1024"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["portfolios:read","portfolios:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/portfolios/rebalancings/executions/{execution_id}/orders","href":"portfolios-rebalancing/list_portfolio_rebalancing_execution_orders","openApiOperationId":"list_portfolio_rebalancing_execution_orders","summary":"List portfolio rebalancing execution orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Portfolios","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1025","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1025","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1025","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1025","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios-rebalancing/list_portfolio_rebalancing_execution_orders"}],"panels":[]}]},"httpPath":"/portfolios/rebalancings/executions/{execution_id}/orders"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Portfolio rebalancing execution orders events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/portfolios-rebalancing/portfolio_rebalancing_execution_order_event","routeSlug":"/api/portfolios-rebalancing/portfolio_rebalancing_execution_order_event","metadata":{"seo":{"title":"Portfolio rebalancing execution orders events","description":"Portfolio rebalancing execution orders events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolio_rebalancing_execution_order_event","name":"Portfolio rebalancing execution orders events","isWebhook":true,"pointer":"/paths/Portfolio rebalancing execution orders events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolio rebalancing execution orders events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Portfolio rebalancing execution orders events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1026","exampleIds":["paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Portfolio rebalancing execution orders events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Portfolio rebalancing execution orders events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Portfolio rebalancing execution orders events","href":"portfolios-rebalancing/portfolio_rebalancing_execution_order_event","openApiOperationId":"portfolio_rebalancing_execution_order_event","summary":"Portfolio rebalancing execution orders events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1026","exampleIds":["paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1026","exampleIds":["paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Portfolio rebalancing execution orders events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portfolios-rebalancing/portfolio_rebalancing_execution_order_event"}],"panels":[]}]},"httpPath":"Portfolio rebalancing execution orders events"}],"content":{"contentType":"group","meta":{"name":"Portfolios Rebalancing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolios Rebalancing","showPageActions":true},{"nodeType":"markdoc","content":"All portfolios rebalancing related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/portfolios/rebalancings/executions","summary":"Trigger portfolio rebalancing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios-rebalancing/trigger_portfolio_rebalancing","deprecated":false},{"title":"/portfolios/rebalancings/executions/{execution_id}","summary":"Retrieve portfolios rebalancing execution","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios-rebalancing/retrieve_portfolios_rebalancing_execution","deprecated":false},{"title":"/portfolios/rebalancings/executions/{execution_id}/orders","summary":"List portfolio rebalancing execution orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portfolios-rebalancing/list_portfolio_rebalancing_execution_orders","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Portfolio rebalancing execution orders events","summary":"Portfolio rebalancing execution orders events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portfolios-rebalancing/portfolio_rebalancing_execution_order_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Savings Plans","link":"/api/savings-plans","routeSlug":"/api/savings-plans","items":[{"label":"Retrieve a savings plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/retrieve_savings_plan","routeSlug":"/api/savings-plans/retrieve_savings_plan","metadata":{"seo":{"title":"Retrieve a savings plan","description":"Retrieve a savings plan specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_savings_plan","name":"Retrieve a savings plan","isWebhook":false,"pointer":"/paths/~1savings_plans~1{savings_plan_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a savings plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a savings plan specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:read","savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"savings_plan_id","in":"path","schemaId":"schema_1027","required":true}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/savings_plans/{savings_plan_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"savings_plan_id","in":"path","required":true,"schemaId":"schema_1027"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:read","savings_plans:admin"]}],"responseCodes":["200","401","403","404","405","406","429","500","503","504"],"pointer":"/savings_plans/{savings_plan_id}","href":"savings-plans/retrieve_savings_plan","openApiOperationId":"retrieve_savings_plan","summary":"Retrieve a savings plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1028","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/retrieve_savings_plan"}],"panels":[]}]},"httpPath":"/savings_plans/{savings_plan_id}"},{"label":"Delete a savings plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/delete_savings_plan","routeSlug":"/api/savings-plans/delete_savings_plan","metadata":{"seo":{"title":"Delete a savings plan","description":"Delete a savings plan specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_savings_plan","name":"Delete a savings plan","isWebhook":false,"pointer":"/paths/~1savings_plans~1{savings_plan_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a savings plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a savings plan specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"savings_plan_id","in":"path","schemaId":"schema_1027","required":true}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/savings_plans/{savings_plan_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"savings_plan_id","in":"path","required":true,"schemaId":"schema_1027"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:admin"]}],"responseCodes":["202","401","403","404","406","409","429","500","503","504"],"pointer":"/savings_plans/{savings_plan_id}","href":"savings-plans/delete_savings_plan","openApiOperationId":"delete_savings_plan","summary":"Delete a savings plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/delete_savings_plan"}],"panels":[]}]},"httpPath":"/savings_plans/{savings_plan_id}"},{"label":"List savings plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/list_savings_plans","routeSlug":"/api/savings-plans/list_savings_plans","metadata":{"seo":{"title":"List savings plans","description":"List savings plans"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_savings_plans","name":"List savings plans","isWebhook":false,"pointer":"/paths/~1savings_plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List savings plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List savings plans"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:read","savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_880","description":"Filters savings plans by account ID","example":"3ada8e9e-82c4-4c78-a43d-a691b1636509"},{"name":"user_id","in":"query","schemaId":"schema_880","description":"Filters savings plans by user ID","example":"996e5e2c-bb76-4a38-8d5c-ff43d86904da"},{"name":"instrument_id","in":"query","schemaId":"schema_1029","description":"Filters savings plans by instrument ID (ISIN)","example":"FR0010524777"},{"name":"sort","in":"query","schemaId":"schema_1001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1savings_plans/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/savings_plans","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","required":false,"example":"3ada8e9e-82c4-4c78-a43d-a691b1636509","schemaId":"schema_880"},{"name":"user_id","in":"query","required":false,"example":"996e5e2c-bb76-4a38-8d5c-ff43d86904da","schemaId":"schema_880"},{"name":"instrument_id","in":"query","required":false,"example":"FR0010524777","schemaId":"schema_1029"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1001"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:read","savings_plans:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/savings_plans","href":"savings-plans/list_savings_plans","openApiOperationId":"list_savings_plans","summary":"List savings plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1030","exampleIds":["paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1030","exampleIds":["paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1030","exampleIds":["paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1030","exampleIds":["paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/list_savings_plans"}],"panels":[]}]},"httpPath":"/savings_plans"},{"label":"Create savings plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/create_savings_plan","routeSlug":"/api/savings-plans/create_savings_plan","metadata":{"seo":{"title":"Create savings plan","description":"Create savings plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_savings_plan","name":"Create savings plan","isWebhook":false,"pointer":"/paths/~1savings_plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create savings plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create savings plan"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1031","exampleIds":["paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument","paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1031","exampleIds":["paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument","paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"],"pointer":"/paths/~1savings_plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/savings_plans","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1031","exampleIds":["paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument","paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"]}},"responseCodes":["202","400","401","403","404","405","406","429","500","503","504"],"pointer":"/savings_plans","href":"savings-plans/create_savings_plan","openApiOperationId":"create_savings_plan","summary":"Create savings plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1031","exampleIds":["paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument","paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1031","exampleIds":["paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument","paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Savings plan object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument","paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument","paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_1028","exampleIds":["paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument","paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1028","exampleIds":["paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument","paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/create_savings_plan"}],"panels":[]}]},"httpPath":"/savings_plans"},{"label":"Retrieve savings plan execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/retrieve_savings_plan_execution","routeSlug":"/api/savings-plans/retrieve_savings_plan_execution","metadata":{"seo":{"title":"Retrieve savings plan execution","description":"Retrieve savings plan execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_savings_plan_execution","name":"Retrieve savings plan execution","isWebhook":false,"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve savings plan execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve savings plan execution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:read","savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"savings_plan_id","in":"path","schemaId":"schema_1027","required":true},{"name":"savings_plan_execution_id","in":"path","schemaId":"schema_1032","required":true}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"savings_plan_id","in":"path","required":true,"schemaId":"schema_1027"},{"name":"savings_plan_execution_id","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:read","savings_plans:admin"]}],"responseCodes":["200","401","403","404","405","406","429","500","503","504"],"pointer":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","href":"savings-plans/retrieve_savings_plan_execution","openApiOperationId":"retrieve_savings_plan_execution","summary":"Retrieve savings plan execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1033","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1033","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1033","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1033","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/retrieve_savings_plan_execution"}],"panels":[]}]},"httpPath":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}"},{"label":"Delete savings plan execution","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/delete_savings_plan_execution","routeSlug":"/api/savings-plans/delete_savings_plan_execution","metadata":{"seo":{"title":"Delete savings plan execution","description":"Delete savings plan execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_savings_plan_execution","name":"Delete savings plan execution","isWebhook":false,"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete savings plan execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete savings plan execution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"savings_plan_id","in":"path","schemaId":"schema_1027","required":true},{"name":"savings_plan_execution_id","in":"path","schemaId":"schema_1032","required":true}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"savings_plan_id","in":"path","required":true,"schemaId":"schema_1027"},{"name":"savings_plan_execution_id","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:admin"]}],"responseCodes":["202","401","403","404","406","409","429","500","503","504"],"pointer":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","href":"savings-plans/delete_savings_plan_execution","openApiOperationId":"delete_savings_plan_execution","summary":"Delete savings plan execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/delete_savings_plan_execution"}],"panels":[]}]},"httpPath":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}"},{"label":"List savings plan executions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/savings-plans/list_savings_plan_executions","routeSlug":"/api/savings-plans/list_savings_plan_executions","metadata":{"seo":{"title":"List savings plan executions","description":"List savings plan executions for a saving plan specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_savings_plan_executions","name":"List savings plan executions","isWebhook":false,"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List savings plan executions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List savings plan executions for a saving plan specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["savings_plans:read","savings_plans:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"savings_plan_id","in":"path","schemaId":"schema_1027","required":true}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_1034","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1035","example":"2022-10-14T10:10:10Z"},{"name":"sort","in":"query","schemaId":"schema_1036","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/savings_plans/{savings_plan_id}/executions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"savings_plan_id","in":"path","required":true,"schemaId":"schema_1027"}],"query":[{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1034"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1035"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1036"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["savings_plans:read","savings_plans:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/savings_plans/{savings_plan_id}/executions","href":"savings-plans/list_savings_plan_executions","openApiOperationId":"list_savings_plan_executions","summary":"List savings plan executions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1037","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1037","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1037","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1037","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument","paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/list_savings_plan_executions"}],"panels":[]}]},"httpPath":"/savings_plans/{savings_plan_id}/executions"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Savings plan execution events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/savings-plans/savings_plan_execution_event","routeSlug":"/api/savings-plans/savings_plan_execution_event","metadata":{"seo":{"title":"Savings plan execution events","description":"Savings plan execution events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"savings_plan_execution_event","name":"Savings plan execution events","isWebhook":true,"pointer":"/paths/Savings plan execution events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Savings plan execution events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Savings plan execution events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1038","exampleIds":["paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1038","exampleIds":["paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"],"pointer":"/paths/Savings plan execution events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Savings plan execution events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1038","exampleIds":["paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"]}},"responseCodes":["200"],"pointer":"Savings plan execution events","href":"savings-plans/savings_plan_execution_event","openApiOperationId":"savings_plan_execution_event","summary":"Savings plan execution events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1038","exampleIds":["paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1038","exampleIds":["paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Savings plan execution events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/savings_plan_execution_event"}],"panels":[]}]},"httpPath":"Savings plan execution events"},{"label":"Savings plan events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/savings-plans/savings_plan_event","routeSlug":"/api/savings-plans/savings_plan_event","metadata":{"seo":{"title":"Savings plan events","description":"Savings plan events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"savings_plan_event","name":"Savings plan events","isWebhook":true,"pointer":"/paths/Savings plan events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Savings plan events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Savings plan events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1039","exampleIds":["paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"]}},"schemaId":"schema_1039","exampleIds":["paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"],"pointer":"/paths/Savings plan events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Savings plan events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1039","exampleIds":["paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"]}},"responseCodes":["200"],"pointer":"Savings plan events","href":"savings-plans/savings_plan_event","openApiOperationId":"savings_plan_event","summary":"Savings plan events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1039","exampleIds":["paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1039","exampleIds":["paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument","paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Savings plan events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savings-plans/savings_plan_event"}],"panels":[]}]},"httpPath":"Savings plan events"}],"content":{"contentType":"group","meta":{"name":"Savings Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Savings Plans","showPageActions":true},{"nodeType":"markdoc","content":"All savings plans related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/savings_plans/{savings_plan_id}","summary":"Retrieve a savings plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/savings-plans/retrieve_savings_plan","deprecated":false},{"title":"/savings_plans/{savings_plan_id}","summary":"Delete a savings plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/savings-plans/delete_savings_plan","deprecated":false},{"title":"/savings_plans","summary":"List savings plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/savings-plans/list_savings_plans","deprecated":false},{"title":"/savings_plans","summary":"Create savings plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/savings-plans/create_savings_plan","deprecated":false},{"title":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","summary":"Retrieve savings plan execution","prefix":{"name":"get","color":"get"},"badges":[],"link":"/savings-plans/retrieve_savings_plan_execution","deprecated":false},{"title":"/savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}","summary":"Delete savings plan execution","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/savings-plans/delete_savings_plan_execution","deprecated":false},{"title":"/savings_plans/{savings_plan_id}/executions","summary":"List savings plan executions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/savings-plans/list_savings_plan_executions","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Savings plan execution events","summary":"Savings plan execution events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/savings-plans/savings_plan_execution_event","deprecated":false},{"title":"Savings plan events","summary":"Savings plan events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/savings-plans/savings_plan_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Liquidations","link":"/api/liquidations","routeSlug":"/api/liquidations","items":[{"label":"List accounts liquidations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/liquidations/list_accounts_liquidations","routeSlug":"/api/liquidations/list_accounts_liquidations","metadata":{"seo":{"title":"List accounts liquidations","description":"List accounts liquidations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_accounts_liquidations","name":"List accounts liquidations","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1liquidations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts liquidations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List accounts liquidations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_liquidations:read","account_liquidations:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1002","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. By default, only ASC for ascending sort."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns accounts liquidations created starting from and including this date (UTC)","example":"2022-10-14T10:10:10Z"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns accounts liquidations created up until this date (UTC)","example":"2022-10-14T10:10:10Z"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/liquidations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1001"},{"name":"order","in":"query","required":false,"schemaId":"schema_1002"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"start_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"},{"name":"end_date","in":"query","required":false,"example":"2022-10-14T10:10:10Z","schemaId":"schema_1003"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_liquidations:read","account_liquidations:admin"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/accounts/{account_id}/liquidations","href":"liquidations/list_accounts_liquidations","openApiOperationId":"list_accounts_liquidations","summary":"List accounts liquidations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Accounts liquidations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1040","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1040","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1040","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1040","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/list_accounts_liquidations"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/liquidations"},{"label":"Create account liquidation request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/liquidations/create_account_liquidation","routeSlug":"/api/liquidations/create_account_liquidation","metadata":{"seo":{"title":"Create account liquidation request","description":"Create account liquidation request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_account_liquidation","name":"Create account liquidation request","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1liquidations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account liquidation request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create account liquidation request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_liquidations:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1041","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1041","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{account_id}/liquidations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_liquidations:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1041","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/liquidations","href":"liquidations/create_account_liquidation","openApiOperationId":"create_account_liquidation","summary":"Create account liquidation request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1041","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1041","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Account liquidation object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/create_account_liquidation"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/liquidations"},{"label":"Retrieve account liquidation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/liquidations/retrieve_account_liquidation","routeSlug":"/api/liquidations/retrieve_account_liquidation","metadata":{"seo":{"title":"Retrieve account liquidation","description":"Retrieve account liquidation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account_liquidation","name":"Retrieve account liquidation","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account liquidation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve account liquidation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_liquidations:read","account_liquidations:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true},{"name":"account_liquidation_id","in":"path","schemaId":"schema_1043","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/liquidations/{account_liquidation_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"},{"name":"account_liquidation_id","in":"path","required":true,"schemaId":"schema_1043"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_liquidations:read","account_liquidations:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/liquidations/{account_liquidation_id}","href":"liquidations/retrieve_account_liquidation","openApiOperationId":"retrieve_account_liquidation","summary":"Retrieve account liquidation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account liquidation object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1042","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/retrieve_account_liquidation"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/liquidations/{account_liquidation_id}"},{"label":"Cancel account liquidation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/liquidations/cancel_account_liquidation","routeSlug":"/api/liquidations/cancel_account_liquidation","metadata":{"seo":{"title":"Cancel account liquidation","description":"Cancel account liquidation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_account_liquidation","name":"Cancel account liquidation","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel account liquidation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel account liquidation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_liquidations:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true},{"name":"account_liquidation_id","in":"path","schemaId":"schema_1043","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accounts/{account_id}/liquidations/{account_liquidation_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"},{"name":"account_liquidation_id","in":"path","required":true,"schemaId":"schema_1043"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_liquidations:admin"]}],"responseCodes":["204","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/liquidations/{account_liquidation_id}","href":"liquidations/cancel_account_liquidation","openApiOperationId":"cancel_account_liquidation","summary":"Cancel account liquidation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/cancel_account_liquidation"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/liquidations/{account_liquidation_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account liquidation events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/liquidations/account_liquidation_event","routeSlug":"/api/liquidations/account_liquidation_event","metadata":{"seo":{"title":"Account liquidation events","description":"Account liquidation events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_liquidation_event","name":"Account liquidation events","isWebhook":true,"pointer":"/paths/Account liquidation events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account liquidation events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account liquidation events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1044","exampleIds":["paths/Account liquidation events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1044","exampleIds":["paths/Account liquidation events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Account liquidation events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account liquidation events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1044","exampleIds":["paths/Account liquidation events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Account liquidation events","href":"liquidations/account_liquidation_event","openApiOperationId":"account_liquidation_event","summary":"Account liquidation events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1044","exampleIds":["paths/Account liquidation events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1044","exampleIds":["paths/Account liquidation events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account liquidation events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidations/account_liquidation_event"}],"panels":[]}]},"httpPath":"Account liquidation events"}],"content":{"contentType":"group","meta":{"name":"Liquidations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Liquidations","showPageActions":true},{"nodeType":"markdoc","content":"All accounts liquidations related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{account_id}/liquidations","summary":"List accounts liquidations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidations/list_accounts_liquidations","deprecated":false},{"title":"/accounts/{account_id}/liquidations","summary":"Create account liquidation request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/liquidations/create_account_liquidation","deprecated":false},{"title":"/accounts/{account_id}/liquidations/{account_liquidation_id}","summary":"Retrieve account liquidation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidations/retrieve_account_liquidation","deprecated":false},{"title":"/accounts/{account_id}/liquidations/{account_liquidation_id}","summary":"Cancel account liquidation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/liquidations/cancel_account_liquidation","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account liquidation events","summary":"Account liquidation events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/liquidations/account_liquidation_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Direct Debits","link":"/api/direct-debits","routeSlug":"/api/direct-debits","items":[{"label":"List direct debits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/direct-debits/list_direct_debits","routeSlug":"/api/direct-debits/list_direct_debits","metadata":{"seo":{"title":"List direct debits","description":"List direct debits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_direct_debits","name":"List direct debits","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List direct debits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List direct debits"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/direct_debits","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/direct_debits","href":"direct-debits/list_direct_debits","openApiOperationId":"list_direct_debits","summary":"List direct debits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Direct debits list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1046","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1046","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1046","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1046","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debits/list_direct_debits"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/direct_debits"},{"label":"Trigger a direct debit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/direct-debits/create_direct_debit","routeSlug":"/api/direct-debits/create_direct_debit","metadata":{"seo":{"title":"Trigger a direct debit","description":"Trigger a direct debit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_direct_debit","name":"Trigger a direct debit","isWebhook":false,"pointer":"/paths/~1payments~1direct_debits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a direct debit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger a direct debit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is deprecated, optional, and will be removed in a future version. For business account direct debits, ownership is determined by the mandate linked to the business."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1direct_debits/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1047","exampleIds":["paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1047","exampleIds":["paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payments~1direct_debits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/direct_debits","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1047","exampleIds":["paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/direct_debits","href":"direct-debits/create_direct_debit","openApiOperationId":"create_direct_debit","summary":"Trigger a direct debit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1047","exampleIds":["paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1047","exampleIds":["paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Direct debit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1direct_debits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debits/create_direct_debit"}],"panels":[]}]},"httpPath":"/payments/direct_debits"},{"label":"Retrieve a direct debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/direct-debits/retrieve_direct_debit","routeSlug":"/api/direct-debits/retrieve_direct_debit","metadata":{"seo":{"title":"Retrieve a direct debit","description":"Retrieve a direct debit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_direct_debit","name":"Retrieve a direct debit","isWebhook":false,"pointer":"/paths/~1payments~1direct_debits~1{direct_debit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a direct debit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a direct debit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"direct_debit_id","in":"path","schemaId":"schema_1049","required":true}],"pointer":"/paths/~1payments~1direct_debits~1{direct_debit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1direct_debits~1{direct_debit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/direct_debits/{direct_debit_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"direct_debit_id","in":"path","required":true,"schemaId":"schema_1049"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/direct_debits/{direct_debit_id}","href":"direct-debits/retrieve_direct_debit","openApiOperationId":"retrieve_direct_debit","summary":"Retrieve a direct debit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Direct debit payment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled"]}},"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debits/retrieve_direct_debit"}],"panels":[]}]},"httpPath":"/payments/direct_debits/{direct_debit_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Direct Debit events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/direct-debits/direct_debit_event","routeSlug":"/api/direct-debits/direct_debit_event","metadata":{"seo":{"title":"Direct Debit events","description":"Direct Debit events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"direct_debit_event","name":"Direct Debit events","isWebhook":true,"pointer":"/paths/Direct Debit events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Direct Debit events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Direct Debit events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1050","exampleIds":["paths/Direct Debit events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1050","exampleIds":["paths/Direct Debit events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Direct Debit events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Direct Debit events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1050","exampleIds":["paths/Direct Debit events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Direct Debit events","href":"direct-debits/direct_debit_event","openApiOperationId":"direct_debit_event","summary":"Direct Debit events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1050","exampleIds":["paths/Direct Debit events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1050","exampleIds":["paths/Direct Debit events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Direct Debit events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debits/direct_debit_event"}],"panels":[]}]},"httpPath":"Direct Debit events"}],"content":{"contentType":"group","meta":{"name":"Direct Debits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Direct Debits","showPageActions":true},{"nodeType":"markdoc","content":"All direct debits related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_groups/{account_group_id}/payments/direct_debits","summary":"List direct debits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/direct-debits/list_direct_debits","deprecated":false},{"title":"/payments/direct_debits","summary":"Trigger a direct debit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/direct-debits/create_direct_debit","deprecated":false},{"title":"/payments/direct_debits/{direct_debit_id}","summary":"Retrieve a direct debit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/direct-debits/retrieve_direct_debit","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Direct Debit events","summary":"Direct Debit events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/direct-debits/direct_debit_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Top-ups","link":"/api/top-ups","routeSlug":"/api/top-ups","items":[{"label":"List top-ups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/top-ups/list_topups","routeSlug":"/api/top-ups/list_topups","metadata":{"seo":{"title":"List top-ups","description":"Returns a list of top-ups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_topups","name":"List top-ups","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1topups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List top-ups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of top-ups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["topups:admin","topups:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1topups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1topups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1topups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/topups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["topups:admin","topups:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/topups","href":"top-ups/list_topups","openApiOperationId":"list_topups","summary":"List top-ups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of top-ups.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1051","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1051","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/list_topups"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/topups"},{"label":"Trigger a top-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/top-ups/create_topup","routeSlug":"/api/top-ups/create_topup","metadata":{"seo":{"title":"Trigger a top-up","description":"Triggers the creation of a top-up payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_topup","name":"Trigger a top-up","isWebhook":false,"pointer":"/paths/~1payments~1topups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a top-up","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggers the creation of a top-up payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["topups:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1topups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1052","exampleIds":["paths/~1payments~1topups/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1052","exampleIds":["paths/~1payments~1topups/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payments~1topups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/topups","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["topups:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1052","exampleIds":["paths/~1payments~1topups/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/topups","href":"top-ups/create_topup","openApiOperationId":"create_topup","summary":"Trigger a top-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1052","exampleIds":["paths/~1payments~1topups/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1052","exampleIds":["paths/~1payments~1topups/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Top-up created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1topups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/create_topup"}],"panels":[]}]},"httpPath":"/payments/topups"},{"label":"Retrieve a top-up by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/top-ups/retrieve_topup","routeSlug":"/api/top-ups/retrieve_topup","metadata":{"seo":{"title":"Retrieve a top-up by ID","description":"Returns a top-up specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_topup","name":"Retrieve a top-up by ID","isWebhook":false,"pointer":"/paths/~1payments~1topups~1{topup_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a top-up by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a top-up specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["topups:admin","topups:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"topup_id","in":"path","schemaId":"schema_1054","required":true}],"pointer":"/paths/~1payments~1topups~1{topup_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1topups~1{topup_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/topups/{topup_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"topup_id","in":"path","required":true,"schemaId":"schema_1054"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["topups:admin","topups:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/topups/{topup_id}","href":"top-ups/retrieve_topup","openApiOperationId":"retrieve_topup","summary":"Retrieve a top-up by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1topups~1{topup_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/retrieve_topup"}],"panels":[]}]},"httpPath":"/payments/topups/{topup_id}"},{"label":"Cancel a top-up by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/top-ups/cancel_topup","routeSlug":"/api/top-ups/cancel_topup","metadata":{"seo":{"title":"Cancel a top-up by ID","description":"Cancels a top-up specified by its ID. It is only possible to cancel a top-up if it has the status CONFIRMED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_topup","name":"Cancel a top-up by ID","isWebhook":false,"pointer":"/paths/~1payments~1topups~1{topup_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a top-up by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a top-up specified by its ID. It is only possible to cancel a top-up if it has the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFIRMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["topups:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"topup_id","in":"path","schemaId":"schema_1054","required":true}],"pointer":"/paths/~1payments~1topups~1{topup_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1topups~1{topup_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/topups/{topup_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"topup_id","in":"path","required":true,"schemaId":"schema_1054"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["topups:admin"]}],"responseCodes":["204","401","403","404","422","429","500","503","504"],"pointer":"/payments/topups/{topup_id}","href":"top-ups/cancel_topup","openApiOperationId":"cancel_topup","summary":"Cancel a top-up by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1topups~1{topup_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/cancel_topup"}],"panels":[]}]},"httpPath":"/payments/topups/{topup_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Top-up events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/top-ups/topup_event","routeSlug":"/api/top-ups/topup_event","metadata":{"seo":{"title":"Top-up events","description":"Top-up events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"topup_event","name":"Top-up events","isWebhook":true,"pointer":"/paths/Top-up events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Top-up events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Top-up events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1055","exampleIds":["paths/Top-up events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1055","exampleIds":["paths/Top-up events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Top-up events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Top-up events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1055","exampleIds":["paths/Top-up events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Top-up events","href":"top-ups/topup_event","openApiOperationId":"topup_event","summary":"Top-up events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1055","exampleIds":["paths/Top-up events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1055","exampleIds":["paths/Top-up events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Top-up events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/topup_event"}],"panels":[]}]},"httpPath":"Top-up events"}],"content":{"contentType":"group","meta":{"name":"Top-ups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Top-ups","showPageActions":true},{"nodeType":"markdoc","content":"All top-ups related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_groups/{account_group_id}/payments/topups","summary":"List top-ups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/top-ups/list_topups","deprecated":false},{"title":"/payments/topups","summary":"Trigger a top-up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/top-ups/create_topup","deprecated":false},{"title":"/payments/topups/{topup_id}","summary":"Retrieve a top-up by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/top-ups/retrieve_topup","deprecated":false},{"title":"/payments/topups/{topup_id}","summary":"Cancel a top-up by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/top-ups/cancel_topup","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Top-up events","summary":"Top-up events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/top-ups/topup_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Withdrawals","link":"/api/withdrawals","routeSlug":"/api/withdrawals","items":[{"label":"Trigger a withdrawal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/withdrawals/create_cash_withdrawal","routeSlug":"/api/withdrawals/create_cash_withdrawal","metadata":{"seo":{"title":"Trigger a withdrawal","description":"Trigger a withdrawal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_cash_withdrawal","name":"Trigger a withdrawal","isWebhook":false,"pointer":"/paths/~1payments~1withdrawals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a withdrawal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger a withdrawal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is deprecated, optional, and will be removed in a future version. For business account withdrawals, ownership is determined by the reference account linked to the business."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1withdrawals/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1056","exampleIds":["paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1056","exampleIds":["paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payments~1withdrawals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/withdrawals","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1056","exampleIds":["paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/withdrawals","href":"withdrawals/create_cash_withdrawal","openApiOperationId":"create_cash_withdrawal","summary":"Trigger a withdrawal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1056","exampleIds":["paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1056","exampleIds":["paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Withdrawal","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1withdrawals/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/withdrawals/create_cash_withdrawal"}],"panels":[]}]},"httpPath":"/payments/withdrawals"},{"label":"Retrieve withdrawal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/withdrawals/retrieve_cash_withdrawal","routeSlug":"/api/withdrawals/retrieve_cash_withdrawal","metadata":{"seo":{"title":"Retrieve withdrawal","description":"Retrieve withdrawal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_cash_withdrawal","name":"Retrieve withdrawal","isWebhook":false,"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve withdrawal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve withdrawal"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"withdrawal_id","in":"path","schemaId":"schema_1058","required":true}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/withdrawals/{withdrawal_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"withdrawal_id","in":"path","required":true,"schemaId":"schema_1058"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/withdrawals/{withdrawal_id}","href":"withdrawals/retrieve_cash_withdrawal","openApiOperationId":"retrieve_cash_withdrawal","summary":"Retrieve withdrawal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Withdrawal","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled"]}},"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1057","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary","paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/withdrawals/retrieve_cash_withdrawal"}],"panels":[]}]},"httpPath":"/payments/withdrawals/{withdrawal_id}"},{"label":"Cancel withdrawal by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/withdrawals/cancel_cash_withdrawal","routeSlug":"/api/withdrawals/cancel_cash_withdrawal","metadata":{"seo":{"title":"Cancel withdrawal by ID","description":"Cancels a withdrawal specified by its ID. It is only possible to cancel a withdrawal if it has the status NEW."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_cash_withdrawal","name":"Cancel withdrawal by ID","isWebhook":false,"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel withdrawal by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a withdrawal specified by its ID. It is only possible to cancel a withdrawal if it has the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"withdrawal_id","in":"path","schemaId":"schema_1058","required":true}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/withdrawals/{withdrawal_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"withdrawal_id","in":"path","required":true,"schemaId":"schema_1058"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin"]}],"responseCodes":["204","401","403","404","422","429","500","503","504"],"pointer":"/payments/withdrawals/{withdrawal_id}","href":"withdrawals/cancel_cash_withdrawal","openApiOperationId":"cancel_cash_withdrawal","summary":"Cancel withdrawal by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/withdrawals/cancel_cash_withdrawal"}],"panels":[]}]},"httpPath":"/payments/withdrawals/{withdrawal_id}"},{"label":"List withdrawals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/withdrawals/list_cash_withdrawals","routeSlug":"/api/withdrawals/list_cash_withdrawals","metadata":{"seo":{"title":"List withdrawals","description":"List withdrawals"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_cash_withdrawals","name":"List withdrawals","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List withdrawals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List withdrawals"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/withdrawals","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/withdrawals","href":"withdrawals/list_cash_withdrawals","openApiOperationId":"list_cash_withdrawals","summary":"List withdrawals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Withdrawals list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1059","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1059","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1059","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1059","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/withdrawals/list_cash_withdrawals"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/withdrawals"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Withdrawals events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/withdrawals/withdrawal_event","routeSlug":"/api/withdrawals/withdrawal_event","metadata":{"seo":{"title":"Withdrawals events","description":"Withdrawals events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"withdrawal_event","name":"Withdrawals events","isWebhook":true,"pointer":"/paths/Withdrawals events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Withdrawals events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Withdrawals events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1060","exampleIds":["paths/Withdrawals events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1060","exampleIds":["paths/Withdrawals events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Withdrawals events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Withdrawals events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1060","exampleIds":["paths/Withdrawals events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Withdrawals events","href":"withdrawals/withdrawal_event","openApiOperationId":"withdrawal_event","summary":"Withdrawals events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1060","exampleIds":["paths/Withdrawals events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1060","exampleIds":["paths/Withdrawals events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Withdrawals events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/withdrawals/withdrawal_event"}],"panels":[]}]},"httpPath":"Withdrawals events"}],"content":{"contentType":"group","meta":{"name":"Withdrawals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Withdrawals","showPageActions":true},{"nodeType":"markdoc","content":"All withdrawals related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/withdrawals","summary":"Trigger a withdrawal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/withdrawals/create_cash_withdrawal","deprecated":false},{"title":"/payments/withdrawals/{withdrawal_id}","summary":"Retrieve withdrawal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/withdrawals/retrieve_cash_withdrawal","deprecated":false},{"title":"/payments/withdrawals/{withdrawal_id}","summary":"Cancel withdrawal by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/withdrawals/cancel_cash_withdrawal","deprecated":false},{"title":"/account_groups/{account_group_id}/payments/withdrawals","summary":"List withdrawals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/withdrawals/list_cash_withdrawals","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Withdrawals events","summary":"Withdrawals events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/withdrawals/withdrawal_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Cash Balance Transfers","link":"/api/cash-balance-transfers","routeSlug":"/api/cash-balance-transfers","items":[{"label":"List cash balance transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/list_cash_balance_transfers","routeSlug":"/api/cash-balance-transfers/list_cash_balance_transfers","metadata":{"seo":{"title":"List cash balance transfers","description":"List all cash balance transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_cash_balance_transfers","name":"List cash balance transfers","isWebhook":false,"pointer":"/paths/~1payments~1cash_balance_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash balance transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all cash balance transfers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1payments~1cash_balance_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1cash_balance_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/cash_balance_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/cash_balance_transfers","href":"cash-balance-transfers/list_cash_balance_transfers","openApiOperationId":"list_cash_balance_transfers","summary":"List cash balance transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash balance transfers list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1061","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1061","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1cash_balance_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1061","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1061","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/list_cash_balance_transfers"}],"panels":[]}]},"httpPath":"/payments/cash_balance_transfers"},{"label":"Create a cash balance transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/create_cash_balance_transfer","routeSlug":"/api/cash-balance-transfers/create_cash_balance_transfer","metadata":{"seo":{"title":"Create a cash balance transfer","description":"Create an internal cash balance transfer between two account groups belonging to the same user and tenant. The cash leaves the source account group and arrives at the target account group as a single operation, with no external bank transfer. Only settled cash denominated in the same currency (EUR) can be transferred. Both account groups must be of the same type, and the type must be one of PERSONAL, CHILD, or BUSINESS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_cash_balance_transfer","name":"Create a cash balance transfer","isWebhook":false,"pointer":"/paths/~1payments~1cash_balance_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a cash balance transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an internal cash balance transfer between two account groups belonging to the same user and tenant. The cash leaves the source account group and arrives at the target account group as a single operation, with no external bank transfer. Only settled cash denominated in the same currency (EUR) can be transferred. Both account groups must be of the same type, and the type must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1cash_balance_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1062","exampleIds":["paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1062","exampleIds":["paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payments~1cash_balance_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/cash_balance_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1062","exampleIds":["paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/cash_balance_transfers","href":"cash-balance-transfers/create_cash_balance_transfer","openApiOperationId":"create_cash_balance_transfer","summary":"Create a cash balance transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1062","exampleIds":["paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1062","exampleIds":["paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash balance transfer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1cash_balance_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/create_cash_balance_transfer"}],"panels":[]}]},"httpPath":"/payments/cash_balance_transfers"},{"label":"Retrieve cash balance transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/retrieve_cash_balance_transfer","routeSlug":"/api/cash-balance-transfers/retrieve_cash_balance_transfer","metadata":{"seo":{"title":"Retrieve cash balance transfer","description":"Retrieve a cash balance transfer by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_cash_balance_transfer","name":"Retrieve cash balance transfer","isWebhook":false,"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve cash balance transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a cash balance transfer by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cash_balance_transfer_id","in":"path","schemaId":"schema_1064","required":true}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"cash_balance_transfer_id","in":"path","required":true,"schemaId":"schema_1064"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","href":"cash-balance-transfers/retrieve_cash_balance_transfer","openApiOperationId":"retrieve_cash_balance_transfer","summary":"Retrieve cash balance transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash balance transfer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1063","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/retrieve_cash_balance_transfer"}],"panels":[]}]},"httpPath":"/payments/cash_balance_transfers/{cash_balance_transfer_id}"},{"label":"Cancel cash balance transfer by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/cancel_cash_balance_transfer","routeSlug":"/api/cash-balance-transfers/cancel_cash_balance_transfer","metadata":{"seo":{"title":"Cancel cash balance transfer by ID","description":"Cancels a cash balance transfer specified by its ID. It is only possible to cancel a transfer while it has the status ISSUED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_cash_balance_transfer","name":"Cancel cash balance transfer by ID","isWebhook":false,"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel cash balance transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a cash balance transfer specified by its ID. It is only possible to cancel a transfer while it has the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISSUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cash_balance_transfer_id","in":"path","schemaId":"schema_1064","required":true}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"cash_balance_transfer_id","in":"path","required":true,"schemaId":"schema_1064"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin"]}],"responseCodes":["204","401","403","404","422","429","500","503","504"],"pointer":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","href":"cash-balance-transfers/cancel_cash_balance_transfer","openApiOperationId":"cancel_cash_balance_transfer","summary":"Cancel cash balance transfer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/cancel_cash_balance_transfer"}],"panels":[]}]},"httpPath":"/payments/cash_balance_transfers/{cash_balance_transfer_id}"},{"label":"List cash balance transfers of a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/list_user_cash_balance_transfers","routeSlug":"/api/cash-balance-transfers/list_user_cash_balance_transfers","metadata":{"seo":{"title":"List cash balance transfers of a user","description":"Returns the list of cash balance transfers of a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_cash_balance_transfers","name":"List cash balance transfers of a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash balance transfers of a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of cash balance transfers of a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/payments/cash_balance_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/payments/cash_balance_transfers","href":"cash-balance-transfers/list_user_cash_balance_transfers","openApiOperationId":"list_user_cash_balance_transfers","summary":"List cash balance transfers of a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash balance transfers list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1065","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1065","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1065","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1065","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/list_user_cash_balance_transfers"}],"panels":[]}]},"httpPath":"/users/{user_id}/payments/cash_balance_transfers"},{"label":"List cash balance transfers of a business","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balance-transfers/list_business_cash_balance_transfers","routeSlug":"/api/cash-balance-transfers/list_business_cash_balance_transfers","metadata":{"seo":{"title":"List cash balance transfers of a business","description":"Returns the list of cash balance transfers of a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_cash_balance_transfers","name":"List cash balance transfers of a business","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash balance transfers of a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of cash balance transfers of a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/payments/cash_balance_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["cash_balance_transfers:admin","cash_balance_transfers:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/payments/cash_balance_transfers","href":"cash-balance-transfers/list_business_cash_balance_transfers","openApiOperationId":"list_business_cash_balance_transfers","summary":"List cash balance transfers of a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash balance transfers list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1066","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1066","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1066","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1066","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/list_business_cash_balance_transfers"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/payments/cash_balance_transfers"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Cash Balance Transfers events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/cash-balance-transfers/cash_balance_transfer_event","routeSlug":"/api/cash-balance-transfers/cash_balance_transfer_event","metadata":{"seo":{"title":"Cash Balance Transfers events","description":"Cash Balance Transfers events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cash_balance_transfer_event","name":"Cash Balance Transfers events","isWebhook":true,"pointer":"/paths/Cash Balance Transfers events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash Balance Transfers events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cash Balance Transfers events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1067","exampleIds":["paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1067","exampleIds":["paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Cash Balance Transfers events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Cash Balance Transfers events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1067","exampleIds":["paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Cash Balance Transfers events","href":"cash-balance-transfers/cash_balance_transfer_event","openApiOperationId":"cash_balance_transfer_event","summary":"Cash Balance Transfers events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1067","exampleIds":["paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1067","exampleIds":["paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Cash Balance Transfers events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balance-transfers/cash_balance_transfer_event"}],"panels":[]}]},"httpPath":"Cash Balance Transfers events"}],"content":{"contentType":"group","meta":{"name":"Cash Balance Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash Balance Transfers","showPageActions":true},{"nodeType":"markdoc","content":"All cash balance transfer related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/cash_balance_transfers","summary":"List cash balance transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balance-transfers/list_cash_balance_transfers","deprecated":false},{"title":"/payments/cash_balance_transfers","summary":"Create a cash balance transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cash-balance-transfers/create_cash_balance_transfer","deprecated":false},{"title":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","summary":"Retrieve cash balance transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balance-transfers/retrieve_cash_balance_transfer","deprecated":false},{"title":"/payments/cash_balance_transfers/{cash_balance_transfer_id}","summary":"Cancel cash balance transfer by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cash-balance-transfers/cancel_cash_balance_transfer","deprecated":false},{"title":"/users/{user_id}/payments/cash_balance_transfers","summary":"List cash balance transfers of a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balance-transfers/list_user_cash_balance_transfers","deprecated":false},{"title":"/businesses/{business_id}/payments/cash_balance_transfers","summary":"List cash balance transfers of a business","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balance-transfers/list_business_cash_balance_transfers","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Cash Balance Transfers events","summary":"Cash Balance Transfers events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cash-balance-transfers/cash_balance_transfer_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Reference Accounts","link":"/api/reference-accounts","routeSlug":"/api/reference-accounts","items":[{"label":"Get reference accounts of a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reference-accounts/list_reference_accounts","routeSlug":"/api/reference-accounts/list_reference_accounts","metadata":{"seo":{"title":"Get reference accounts of a user","description":"Returns the list of reference accounts of a user specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_reference_accounts","name":"Get reference accounts of a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1payments~1reference_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get reference accounts of a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of reference accounts of a user specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reference_accounts:admin","reference_accounts:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1payments~1reference_accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1payments~1reference_accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1payments~1reference_accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/payments/reference_accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reference_accounts:admin","reference_accounts:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/payments/reference_accounts","href":"reference-accounts/list_reference_accounts","openApiOperationId":"list_reference_accounts","summary":"Get reference accounts of a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1068","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA"]}},"schemaId":"schema_1068","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1068","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1068","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-accounts/list_reference_accounts"}],"panels":[]}]},"httpPath":"/users/{user_id}/payments/reference_accounts"},{"label":"Create a reference account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reference-accounts/create_reference_account","routeSlug":"/api/reference-accounts/create_reference_account","metadata":{"seo":{"title":"Create a reference account","description":"Creates a new reference account for a user or business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_reference_account","name":"Create a reference account","isWebhook":false,"pointer":"/paths/~1payments~1reference_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a reference account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new reference account for a user or business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reference_accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1reference_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1069","exampleIds":["paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"]}},"schemaId":"schema_1069","exampleIds":["paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"],"pointer":"/paths/~1payments~1reference_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/reference_accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reference_accounts:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1069","exampleIds":["paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/reference_accounts","href":"reference-accounts/create_reference_account","openApiOperationId":"create_reference_account","summary":"Create a reference account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1069","exampleIds":["paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1069","exampleIds":["paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reference account created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business"]}},"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1reference_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA","paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-accounts/create_reference_account"}],"panels":[]}]},"httpPath":"/payments/reference_accounts"},{"label":"Get a reference account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reference-accounts/retrieve_reference_account","routeSlug":"/api/reference-accounts/retrieve_reference_account","metadata":{"seo":{"title":"Get a reference account by ID","description":"Retrieves the reference account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_reference_account","name":"Get a reference account by ID","isWebhook":false,"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a reference account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the reference account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reference_accounts:admin","reference_accounts:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference_account_id","in":"path","schemaId":"schema_1071","required":true}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/reference_accounts/{reference_account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"reference_account_id","in":"path","required":true,"schemaId":"schema_1071"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reference_accounts:admin","reference_accounts:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/reference_accounts/{reference_account_id}","href":"reference-accounts/retrieve_reference_account","openApiOperationId":"retrieve_reference_account","summary":"Get a reference account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA"]}},"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1070","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-accounts/retrieve_reference_account"}],"panels":[]}]},"httpPath":"/payments/reference_accounts/{reference_account_id}"},{"label":"Delete a reference account by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reference-accounts/delete_reference_account","routeSlug":"/api/reference-accounts/delete_reference_account","metadata":{"seo":{"title":"Delete a reference account by ID","description":"Deletes the reference account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_reference_account","name":"Delete a reference account by ID","isWebhook":false,"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a reference account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the reference account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reference_accounts:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference_account_id","in":"path","schemaId":"schema_1071","required":true}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/reference_accounts/{reference_account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"reference_account_id","in":"path","required":true,"schemaId":"schema_1071"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reference_accounts:admin"]}],"responseCodes":["204","401","403","404","429","500","503","504"],"pointer":"/payments/reference_accounts/{reference_account_id}","href":"reference-accounts/delete_reference_account","openApiOperationId":"delete_reference_account","summary":"Delete a reference account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-accounts/delete_reference_account"}],"panels":[]}]},"httpPath":"/payments/reference_accounts/{reference_account_id}"},{"label":"Get reference accounts of a business","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reference-accounts/list_business_reference_accounts","routeSlug":"/api/reference-accounts/list_business_reference_accounts","metadata":{"seo":{"title":"Get reference accounts of a business","description":"Returns the list of reference accounts for a business specified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_reference_accounts","name":"Get reference accounts of a business","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1payments~1reference_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get reference accounts of a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of reference accounts for a business specified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reference_accounts:admin","reference_accounts:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/payments/reference_accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reference_accounts:admin","reference_accounts:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/payments/reference_accounts","href":"reference-accounts/list_business_reference_accounts","openApiOperationId":"list_business_reference_accounts","summary":"Get reference accounts of a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Business reference accounts list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1072","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1072","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1072","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1072","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-accounts/list_business_reference_accounts"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/payments/reference_accounts"}],"content":{"contentType":"group","meta":{"name":"Reference Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference Accounts","showPageActions":true},{"nodeType":"markdoc","content":"All reference account related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/payments/reference_accounts","summary":"Get reference accounts of a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-accounts/list_reference_accounts","deprecated":false},{"title":"/payments/reference_accounts","summary":"Create a reference account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reference-accounts/create_reference_account","deprecated":false},{"title":"/payments/reference_accounts/{reference_account_id}","summary":"Get a reference account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-accounts/retrieve_reference_account","deprecated":false},{"title":"/payments/reference_accounts/{reference_account_id}","summary":"Delete a reference account by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/reference-accounts/delete_reference_account","deprecated":false},{"title":"/businesses/{business_id}/payments/reference_accounts","summary":"Get reference accounts of a business","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-accounts/list_business_reference_accounts","deprecated":false}]}]}]}]}},{"type":"group","label":"Mandates","link":"/api/mandates","routeSlug":"/api/mandates","items":[{"label":"List mandates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/mandates/list_mandates","routeSlug":"/api/mandates/list_mandates","metadata":{"seo":{"title":"List mandates","description":"List mandates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_mandates","name":"List mandates","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1payments~1mandates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mandates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List mandates"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["mandates:admin","mandates:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1payments~1mandates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1payments~1mandates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1payments~1mandates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/payments/mandates","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["mandates:admin","mandates:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/payments/mandates","href":"mandates/list_mandates","openApiOperationId":"list_mandates","summary":"List mandates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mandates list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1073","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1073","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1payments~1mandates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1073","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1073","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/list_mandates"}],"panels":[]}]},"httpPath":"/users/{user_id}/payments/mandates"},{"label":"List mandates for a business","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/mandates/list_business_mandates","routeSlug":"/api/mandates/list_business_mandates","metadata":{"seo":{"title":"List mandates for a business","description":"List mandates for a business account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_mandates","name":"List mandates for a business","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1payments~1mandates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mandates for a business","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List mandates for a business account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["mandates:admin","mandates:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1mandates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1mandates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1mandates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/payments/mandates","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["mandates:admin","mandates:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/payments/mandates","href":"mandates/list_business_mandates","openApiOperationId":"list_business_mandates","summary":"List mandates for a business"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mandates list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1074","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1074","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1payments~1mandates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1074","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1074","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/list_business_mandates"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/payments/mandates"},{"label":"Create a mandate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/mandates/create_mandate","routeSlug":"/api/mandates/create_mandate","metadata":{"seo":{"title":"Create a mandate","description":"Create a mandate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_mandate","name":"Create a mandate","isWebhook":false,"pointer":"/paths/~1payments~1mandates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a mandate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports both user and business accounts. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for user flows or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for business flows — exactly one must be specified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["mandates:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1mandates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1075","exampleIds":["paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User","paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"]}},"schemaId":"schema_1075","exampleIds":["paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User","paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"],"pointer":"/paths/~1payments~1mandates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/mandates","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["mandates:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1075","exampleIds":["paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User","paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/mandates","href":"mandates/create_mandate","openApiOperationId":"create_mandate","summary":"Create a mandate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1075","exampleIds":["paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User","paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1075","exampleIds":["paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User","paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mandate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business"]}},"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1mandates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/create_mandate"}],"panels":[]}]},"httpPath":"/payments/mandates"},{"label":"Retrieve a direct debit mandate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/mandates/retrieve_mandate","routeSlug":"/api/mandates/retrieve_mandate","metadata":{"seo":{"title":"Retrieve a direct debit mandate","description":"Retrieve a direct debit mandate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_mandate","name":"Retrieve a direct debit mandate","isWebhook":false,"pointer":"/paths/~1payments~1mandates~1{mandate_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a direct debit mandate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a direct debit mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on whether the mandate belongs to a user or business account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["mandates:admin","mandates:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mandate_id","in":"path","schemaId":"schema_1077","required":true}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/mandates/{mandate_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"mandate_id","in":"path","required":true,"schemaId":"schema_1077"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["mandates:admin","mandates:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/mandates/{mandate_id}","href":"mandates/retrieve_mandate","openApiOperationId":"retrieve_mandate","summary":"Retrieve a direct debit mandate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mandate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business"]}},"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1076","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User","paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/retrieve_mandate"}],"panels":[]}]},"httpPath":"/payments/mandates/{mandate_id}"},{"label":"Delete mandate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/mandates/delete_mandate","routeSlug":"/api/mandates/delete_mandate","metadata":{"seo":{"title":"Delete mandate","description":"Delete mandate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_mandate","name":"Delete mandate","isWebhook":false,"pointer":"/paths/~1payments~1mandates~1{mandate_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete mandate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete mandate"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["mandates:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"mandate_id","in":"path","schemaId":"schema_1077","required":true}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/mandates/{mandate_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"mandate_id","in":"path","required":true,"schemaId":"schema_1077"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["mandates:admin"]}],"responseCodes":["204","401","403","404","429","500","503","504"],"pointer":"/payments/mandates/{mandate_id}","href":"mandates/delete_mandate","openApiOperationId":"delete_mandate","summary":"Delete mandate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1mandates~1{mandate_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/delete_mandate"}],"panels":[]}]},"httpPath":"/payments/mandates/{mandate_id}"}],"content":{"contentType":"group","meta":{"name":"Mandates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mandates","showPageActions":true},{"nodeType":"markdoc","content":"All direct debit mandates related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/payments/mandates","summary":"List mandates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mandates/list_mandates","deprecated":false},{"title":"/businesses/{business_id}/payments/mandates","summary":"List mandates for a business","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mandates/list_business_mandates","deprecated":false},{"title":"/payments/mandates","summary":"Create a mandate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mandates/create_mandate","deprecated":false},{"title":"/payments/mandates/{mandate_id}","summary":"Retrieve a direct debit mandate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mandates/retrieve_mandate","deprecated":false},{"title":"/payments/mandates/{mandate_id}","summary":"Delete mandate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mandates/delete_mandate","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual Bank Accounts","link":"/api/virtual-bank-accounts","routeSlug":"/api/virtual-bank-accounts","items":[{"label":"List virtual bank accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-bank-accounts/list_virtual_bank_accounts","routeSlug":"/api/virtual-bank-accounts/list_virtual_bank_accounts","metadata":{"seo":{"title":"List virtual bank accounts","description":"Returns a list of virtual bank accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_virtual_bank_accounts","name":"List virtual bank accounts","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List virtual bank accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of virtual bank accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/virtual_bank_accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/virtual_bank_accounts","href":"virtual-bank-accounts/list_virtual_bank_accounts","openApiOperationId":"list_virtual_bank_accounts","summary":"List virtual bank accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of virtual bank accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1078","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1078","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1078","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1078","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-bank-accounts/list_virtual_bank_accounts"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/virtual_bank_accounts"},{"label":"Create a virtual bank account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-bank-accounts/create_virtual_bank_account","routeSlug":"/api/virtual-bank-accounts/create_virtual_bank_account","metadata":{"seo":{"title":"Create a virtual bank account","description":"Triggers the creation of a virtual bank account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_virtual_bank_account","name":"Create a virtual bank account","isWebhook":false,"pointer":"/paths/~1payments~1virtual_bank_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a virtual bank account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggers the creation of a virtual bank account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1virtual_bank_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1079","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1079","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payments~1virtual_bank_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/virtual_bank_accounts","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1079","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/payments/virtual_bank_accounts","href":"virtual-bank-accounts/create_virtual_bank_account","openApiOperationId":"create_virtual_bank_account","summary":"Create a virtual bank account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1079","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1079","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Virtual Bank Account created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1virtual_bank_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-bank-accounts/create_virtual_bank_account"}],"panels":[]}]},"httpPath":"/payments/virtual_bank_accounts"},{"label":"Retrieve a virtual bank account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-bank-accounts/retrieve_virtual_bank_account","routeSlug":"/api/virtual-bank-accounts/retrieve_virtual_bank_account","metadata":{"seo":{"title":"Retrieve a virtual bank account by ID","description":"Returns a virtual bank account specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_virtual_bank_account","name":"Retrieve a virtual bank account by ID","isWebhook":false,"pointer":"/paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a virtual bank account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a virtual bank account specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtual_bank_account_id","in":"path","schemaId":"schema_1081","required":true}],"pointer":"/paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/virtual_bank_accounts/{virtual_bank_account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"virtual_bank_account_id","in":"path","required":true,"schemaId":"schema_1081"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/virtual_bank_accounts/{virtual_bank_account_id}","href":"virtual-bank-accounts/retrieve_virtual_bank_account","openApiOperationId":"retrieve_virtual_bank_account","summary":"Retrieve a virtual bank account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1080","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-bank-accounts/retrieve_virtual_bank_account"}],"panels":[]}]},"httpPath":"/payments/virtual_bank_accounts/{virtual_bank_account_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Virtual Bank Accounts events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/virtual-bank-accounts/virtual_bank_account_event","routeSlug":"/api/virtual-bank-accounts/virtual_bank_account_event","metadata":{"seo":{"title":"Virtual Bank Accounts events","description":"Virtual Bank Accounts events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"virtual_bank_account_event","name":"Virtual Bank Accounts events","isWebhook":true,"pointer":"/paths/Virtual Bank Accounts events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual Bank Accounts events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Virtual Bank Accounts events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1082","exampleIds":["paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1082","exampleIds":["paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Virtual Bank Accounts events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Virtual Bank Accounts events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1082","exampleIds":["paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Virtual Bank Accounts events","href":"virtual-bank-accounts/virtual_bank_account_event","openApiOperationId":"virtual_bank_account_event","summary":"Virtual Bank Accounts events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1082","exampleIds":["paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1082","exampleIds":["paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Virtual Bank Accounts events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-bank-accounts/virtual_bank_account_event"}],"panels":[]}]},"httpPath":"Virtual Bank Accounts events"}],"content":{"contentType":"group","meta":{"name":"Virtual Bank Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual Bank Accounts","showPageActions":true},{"nodeType":"markdoc","content":"All virtual bank accounts related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_groups/{account_group_id}/payments/virtual_bank_accounts","summary":"List virtual bank accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-bank-accounts/list_virtual_bank_accounts","deprecated":false},{"title":"/payments/virtual_bank_accounts","summary":"Create a virtual bank account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-bank-accounts/create_virtual_bank_account","deprecated":false},{"title":"/payments/virtual_bank_accounts/{virtual_bank_account_id}","summary":"Retrieve a virtual bank account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-bank-accounts/retrieve_virtual_bank_account","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Virtual Bank Accounts events","summary":"Virtual Bank Accounts events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-bank-accounts/virtual_bank_account_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit Fundings","link":"/api/credit-fundings","routeSlug":"/api/credit-fundings","items":[{"label":"Retrieve funding details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/credit-fundings/retrieve_funding_details","routeSlug":"/api/credit-fundings/retrieve_funding_details","metadata":{"seo":{"title":"Retrieve funding details","description":"Retrieve funding details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_funding_details","name":"Retrieve funding details","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve funding details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve funding details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/credit_funding_details","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["payments:admin","payments:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/credit_funding_details","href":"credit-fundings/retrieve_funding_details","openApiOperationId":"retrieve_funding_details","summary":"Retrieve funding details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Funding Details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1083","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1083","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1083","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1083","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-fundings/retrieve_funding_details"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/credit_funding_details"},{"label":"List credit fundings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/credit-fundings/list_credit_fundings","routeSlug":"/api/credit-fundings/list_credit_fundings","metadata":{"seo":{"title":"List credit fundings","description":"List credit fundings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_credit_fundings","name":"List credit fundings","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit fundings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List credit fundings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["credit_fundings:read","payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_971","description":"Field of resource to sort by","example":"created_at"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/credit_fundings","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[{"name":"sort","in":"query","required":false,"example":"created_at","schemaId":"schema_971"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["credit_fundings:read","payments:admin","payments:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/credit_fundings","href":"credit-fundings/list_credit_fundings","openApiOperationId":"list_credit_fundings","summary":"List credit fundings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit Funding list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1084","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1084","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1084","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1084","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-fundings/list_credit_fundings"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/credit_fundings"},{"label":"Retrieve a credit funding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/credit-fundings/retrieve_credit_funding","routeSlug":"/api/credit-fundings/retrieve_credit_funding","metadata":{"seo":{"title":"Retrieve a credit funding","description":"Retrieve a credit funding"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_credit_funding","name":"Retrieve a credit funding","isWebhook":false,"pointer":"/paths/~1payments~1credit_fundings~1{credit_funding_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit funding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a credit funding"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["credit_fundings:read","payments:admin","payments:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credit_funding_id","in":"path","schemaId":"schema_1085","required":true}],"pointer":"/paths/~1payments~1credit_fundings~1{credit_funding_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1payments~1credit_fundings~1{credit_funding_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/credit_fundings/{credit_funding_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"credit_funding_id","in":"path","required":true,"schemaId":"schema_1085"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["credit_fundings:read","payments:admin","payments:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/payments/credit_fundings/{credit_funding_id}","href":"credit-fundings/retrieve_credit_funding","openApiOperationId":"retrieve_credit_funding","summary":"Retrieve a credit funding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit Funding payment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1086","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1086","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1086","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1086","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-fundings/retrieve_credit_funding"}],"panels":[]}]},"httpPath":"/payments/credit_fundings/{credit_funding_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Credit Funding events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/credit-fundings/credit_funding_event","routeSlug":"/api/credit-fundings/credit_funding_event","metadata":{"seo":{"title":"Credit Funding events","description":"Credit Funding events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit_funding_event","name":"Credit Funding events","isWebhook":true,"pointer":"/paths/Credit Funding events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Funding events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Credit Funding events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1087","exampleIds":["paths/Credit Funding events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1087","exampleIds":["paths/Credit Funding events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Credit Funding events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Credit Funding events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1087","exampleIds":["paths/Credit Funding events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Credit Funding events","href":"credit-fundings/credit_funding_event","openApiOperationId":"credit_funding_event","summary":"Credit Funding events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1087","exampleIds":["paths/Credit Funding events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1087","exampleIds":["paths/Credit Funding events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Credit Funding events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-fundings/credit_funding_event"}],"panels":[]}]},"httpPath":"Credit Funding events"}],"content":{"contentType":"group","meta":{"name":"Credit Fundings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Fundings","showPageActions":true},{"nodeType":"markdoc","content":"All credit fundings related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_groups/{account_group_id}/payments/credit_funding_details","summary":"Retrieve funding details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-fundings/retrieve_funding_details","deprecated":false},{"title":"/account_groups/{account_group_id}/payments/credit_fundings","summary":"List credit fundings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-fundings/list_credit_fundings","deprecated":false},{"title":"/payments/credit_fundings/{credit_funding_id}","summary":"Retrieve a credit funding","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-fundings/retrieve_credit_funding","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Credit Funding events","summary":"Credit Funding events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-fundings/credit_funding_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Balances","content":null},{"type":"group","label":"Cash Balances","link":"/api/cash-balances","routeSlug":"/api/cash-balances","items":[{"label":"Retrieve an account group's cash balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balances/retrieve_cash_balances","routeSlug":"/api/cash-balances/retrieve_cash_balances","metadata":{"seo":{"title":"Retrieve an account group's cash balances","description":"Retrieve an account group's cash balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_cash_balances","name":"Retrieve an account group's cash balances","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account group's cash balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an account group's cash balances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["positions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/cash_balances","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["positions:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/cash_balances","href":"cash-balances/retrieve_cash_balances","openApiOperationId":"retrieve_cash_balances","summary":"Retrieve an account group's cash balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1088","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1088","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1088","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1088","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balances/retrieve_cash_balances"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/cash_balances"},{"label":"Retrieve an account group's cash balance for particular ISO currency code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balances/retrieve_cash_balance_with_currency","routeSlug":"/api/cash-balances/retrieve_cash_balance_with_currency","metadata":{"seo":{"title":"Retrieve an account group's cash balance for particular ISO currency code","description":"Retrieve an account group's cash balance for particular ISO currency code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_cash_balance_with_currency","name":"Retrieve an account group's cash balance for particular ISO currency code","isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account group's cash balance for particular ISO currency code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an account group's cash balance for particular ISO currency code"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["positions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true},{"name":"currency","in":"path","schemaId":"schema_1089","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/cash_balances/{currency}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"},{"name":"currency","in":"path","required":true,"schemaId":"schema_1089"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["positions:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/cash_balances/{currency}","href":"cash-balances/retrieve_cash_balance_with_currency","openApiOperationId":"retrieve_cash_balance_with_currency","summary":"Retrieve an account group's cash balance for particular ISO currency code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"]}},"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balances/retrieve_cash_balance_with_currency"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/cash_balances/{currency}"},{"label":"Retrieve an account group's cash balance","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/cash-balances/retrieve_cash_balance","routeSlug":"/api/cash-balances/retrieve_cash_balance","metadata":{"seo":{"title":"Retrieve an account group's cash balance","description":"Retrieve an account group's cash balance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_cash_balance","name":"Retrieve an account group's cash balance","deprecated":true,"isWebhook":false,"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account group's cash balance","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an account group's cash balance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["positions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_group_id","in":"path","schemaId":"schema_944","required":true}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_groups/{account_group_id}/payments/cash_balance","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_group_id","in":"path","required":true,"schemaId":"schema_944"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["positions:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/account_groups/{account_group_id}/payments/cash_balance","href":"cash-balances/retrieve_cash_balance","openApiOperationId":"retrieve_cash_balance","summary":"Retrieve an account group's cash balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"]}},"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1090","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update","paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balances/retrieve_cash_balance"}],"panels":[]}]},"httpPath":"/account_groups/{account_group_id}/payments/cash_balance"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Cash Balance events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/cash-balances/cash_balance_event","routeSlug":"/api/cash-balances/cash_balance_event","metadata":{"seo":{"title":"Cash Balance events","description":"Cash Balance events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cash_balance_event","name":"Cash Balance events","isWebhook":true,"pointer":"/paths/Cash Balance events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash Balance events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cash Balance events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1091","exampleIds":["paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"]}},"schemaId":"schema_1091","exampleIds":["paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"],"pointer":"/paths/Cash Balance events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Cash Balance events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1091","exampleIds":["paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"]}},"responseCodes":["200"],"pointer":"Cash Balance events","href":"cash-balances/cash_balance_event","openApiOperationId":"cash_balance_event","summary":"Cash Balance events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1091","exampleIds":["paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1091","exampleIds":["paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal","paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Cash Balance events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cash-balances/cash_balance_event"}],"panels":[]}]},"httpPath":"Cash Balance events"}],"content":{"contentType":"group","meta":{"name":"Cash Balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash Balances","showPageActions":true},{"nodeType":"markdoc","content":"All cash balance related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_groups/{account_group_id}/payments/cash_balances","summary":"Retrieve an account group's cash balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balances/retrieve_cash_balances","deprecated":false},{"title":"/account_groups/{account_group_id}/payments/cash_balances/{currency}","summary":"Retrieve an account group's cash balance for particular ISO currency code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cash-balances/retrieve_cash_balance_with_currency","deprecated":false},{"title":"/account_groups/{account_group_id}/payments/cash_balance","summary":"Retrieve an account group's cash balance","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/cash-balances/retrieve_cash_balance","deprecated":true}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Cash Balance events","summary":"Cash Balance events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cash-balances/cash_balance_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Positions","link":"/api/positions","routeSlug":"/api/positions","items":[{"label":"List positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/positions/list_positions","routeSlug":"/api/positions/list_positions","metadata":{"seo":{"title":"List positions","description":"List of account positions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_positions","name":"List positions","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List positions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of account positions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["positions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1positions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1{account_id}~1positions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/positions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["positions:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/positions","href":"positions/list_positions","openApiOperationId":"list_positions","summary":"List positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1092","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1092","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1092","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1092","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/positions/list_positions"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/positions"},{"label":"Retrieve position","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/positions/retrieve_position","routeSlug":"/api/positions/retrieve_position","metadata":{"seo":{"title":"Retrieve position","description":"Retrieve an account position"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_position","name":"Retrieve position","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an account position"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["positions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument_id","in":"path","schemaId":"schema_978","required":true},{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/positions/{instrument_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"instrument_id","in":"path","required":true,"schemaId":"schema_978"},{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["positions:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/positions/{instrument_id}","href":"positions/retrieve_position","openApiOperationId":"retrieve_position","summary":"Retrieve position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1093","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update"]}},"schemaId":"schema_1093","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1093","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1093","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update","paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/positions/retrieve_position"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/positions/{instrument_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Positions events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/positions/position_event","routeSlug":"/api/positions/position_event","metadata":{"seo":{"title":"Positions events","description":"Positions events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"position_event","name":"Positions events","isWebhook":true,"pointer":"/paths/Positions events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Positions events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Positions events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1094","exampleIds":["paths/Positions events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1094","exampleIds":["paths/Positions events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Positions events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Positions events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1094","exampleIds":["paths/Positions events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Positions events","href":"positions/position_event","openApiOperationId":"position_event","summary":"Positions events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1094","exampleIds":["paths/Positions events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1094","exampleIds":["paths/Positions events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Positions events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/positions/position_event"}],"panels":[]}]},"httpPath":"Positions events"}],"content":{"contentType":"group","meta":{"name":"Positions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Positions","showPageActions":true},{"nodeType":"markdoc","content":"All positions related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{account_id}/positions","summary":"List positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/positions/list_positions","deprecated":false},{"title":"/accounts/{account_id}/positions/{instrument_id}","summary":"Retrieve position","prefix":{"name":"get","color":"get"},"badges":[],"link":"/positions/retrieve_position","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Positions events","summary":"Positions events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/positions/position_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Valuations","link":"/api/valuations","routeSlug":"/api/valuations","items":[{"label":"Get current valuation for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/valuations/get_account_valuation","routeSlug":"/api/valuations/get_account_valuation","metadata":{"seo":{"title":"Get current valuation for an account","description":"Get current valuation for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_account_valuation","name":"Get current valuation for an account","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1valuations~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get current valuation for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get current valuation for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["valuations:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1valuations~1current/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"price_quality","in":"query","schemaId":"schema_1095","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1valuations~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1valuations~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/valuations/current","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"price_quality","in":"query","required":true,"schemaId":"schema_1095"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["valuations:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/accounts/{account_id}/valuations/current","href":"valuations/get_account_valuation","openApiOperationId":"get_account_valuation","summary":"Get current valuation for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valuations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1096","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1096","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1valuations~1current/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1096","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1096","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/valuations/get_account_valuation"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/valuations/current"},{"label":"List valuation history for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/valuations/list_account_valuation_history","routeSlug":"/api/valuations/list_account_valuation_history","metadata":{"seo":{"title":"List valuation history for an account","description":"List valuation history for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_valuation_history","name":"List valuation history for an account","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1valuations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List valuation history for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List valuation history for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["valuations:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1valuations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_1097","example":"2023-01-03"},{"name":"end_date","in":"query","schemaId":"schema_1098","example":"2023-01-11"},{"name":"sort","in":"query","schemaId":"schema_1099","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valuation_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1{account_id}~1valuations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1valuations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/valuations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"start_date","in":"query","required":false,"example":"2023-01-03","schemaId":"schema_1097"},{"name":"end_date","in":"query","required":false,"example":"2023-01-11","schemaId":"schema_1098"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1099"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["valuations:read"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/accounts/{account_id}/valuations","href":"valuations/list_account_valuation_history","openApiOperationId":"list_account_valuation_history","summary":"List valuation history for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valuations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1100","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1100","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1valuations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1100","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1100","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/valuations/list_account_valuation_history"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/valuations"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account valuation events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/valuations/account_valuation_event","routeSlug":"/api/valuations/account_valuation_event","metadata":{"seo":{"title":"Account valuation events","description":"Account valuation events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_valuation_event","name":"Account valuation events","isWebhook":true,"pointer":"/paths/Account valuation events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account valuation events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account valuation events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1101","exampleIds":["paths/Account valuation events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1101","exampleIds":["paths/Account valuation events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Account valuation events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account valuation events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1101","exampleIds":["paths/Account valuation events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Account valuation events","href":"valuations/account_valuation_event","openApiOperationId":"account_valuation_event","summary":"Account valuation events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1101","exampleIds":["paths/Account valuation events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1101","exampleIds":["paths/Account valuation events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account valuation events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/valuations/account_valuation_event"}],"panels":[]}]},"httpPath":"Account valuation events"},{"label":"Intraday account valuation events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/valuations/intraday_account_valuation_event","routeSlug":"/api/valuations/intraday_account_valuation_event","metadata":{"seo":{"title":"Intraday account valuation events","description":"Intraday account valuation events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"intraday_account_valuation_event","name":"Intraday account valuation events","isWebhook":true,"pointer":"/paths/Intraday account valuation events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intraday account valuation events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Intraday account valuation events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1102","exampleIds":["paths/Intraday account valuation events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1102","exampleIds":["paths/Intraday account valuation events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Intraday account valuation events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Intraday account valuation events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1102","exampleIds":["paths/Intraday account valuation events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Intraday account valuation events","href":"valuations/intraday_account_valuation_event","openApiOperationId":"intraday_account_valuation_event","summary":"Intraday account valuation events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1102","exampleIds":["paths/Intraday account valuation events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1102","exampleIds":["paths/Intraday account valuation events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Intraday account valuation events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/valuations/intraday_account_valuation_event"}],"panels":[]}]},"httpPath":"Intraday account valuation events"}],"content":{"contentType":"group","meta":{"name":"Valuations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Valuations","showPageActions":true},{"nodeType":"markdoc","content":"All valuations related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{account_id}/valuations/current","summary":"Get current valuation for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/valuations/get_account_valuation","deprecated":false},{"title":"/accounts/{account_id}/valuations","summary":"List valuation history for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/valuations/list_account_valuation_history","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account valuation events","summary":"Account valuation events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/valuations/account_valuation_event","deprecated":false},{"title":"Intraday account valuation events","summary":"Intraday account valuation events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/valuations/intraday_account_valuation_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Returns","link":"/api/returns","routeSlug":"/api/returns","items":[{"label":"List account returns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/returns/list_account_returns","routeSlug":"/api/returns/list_account_returns","metadata":{"seo":{"title":"List account returns","description":"List account returns"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_returns","name":"List account returns","isWebhook":false,"pointer":"/paths/~1accounts~1{account_id}~1returns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account returns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List account returns"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_returns:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1accounts~1{account_id}~1returns/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_1003","description":"Returns account returns starting from and including this date (UTC)","example":"2023-08-15"},{"name":"end_date","in":"query","schemaId":"schema_1003","description":"Returns account returns up until this date (UTC)","example":"2023-08-15"},{"name":"sort","in":"query","schemaId":"schema_1103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1{account_id}~1returns/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1accounts~1{account_id}~1returns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{account_id}/returns","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[{"name":"start_date","in":"query","example":"2023-08-15","schemaId":"schema_1003"},{"name":"end_date","in":"query","example":"2023-08-15","schemaId":"schema_1003"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1103"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_returns:read"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/accounts/{account_id}/returns","href":"returns/list_account_returns","openApiOperationId":"list_account_returns","summary":"List account returns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1104","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1104","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1accounts~1{account_id}~1returns/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1104","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1104","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/list_account_returns"}],"panels":[]}]},"httpPath":"/accounts/{account_id}/returns"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account returns event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/returns/account_returns_event","routeSlug":"/api/returns/account_returns_event","metadata":{"seo":{"title":"Account returns event","description":"Account returns event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_returns_event","name":"Account returns event","isWebhook":true,"pointer":"/paths/Account returns events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account returns event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account returns event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1105","exampleIds":["paths/Account returns events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1105","exampleIds":["paths/Account returns events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Account returns events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account returns events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1105","exampleIds":["paths/Account returns events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Account returns events","href":"returns/account_returns_event","openApiOperationId":"account_returns_event","summary":"Account returns event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1105","exampleIds":["paths/Account returns events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1105","exampleIds":["paths/Account returns events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account returns events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/account_returns_event"}],"panels":[]}]},"httpPath":"Account returns events"}],"content":{"contentType":"group","meta":{"name":"Returns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns","showPageActions":true},{"nodeType":"markdoc","content":"All accounts returns related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{account_id}/returns","summary":"List account returns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/list_account_returns","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account returns events","summary":"Account returns event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/account_returns_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual Cash Balances","link":"/api/virtual-cash-balances","routeSlug":"/api/virtual-cash-balances","items":[{"label":"Trigger a virtual cash increase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-cash-balances/create_virtual_cash_increase","routeSlug":"/api/virtual-cash-balances/create_virtual_cash_increase","metadata":{"seo":{"title":"Trigger a virtual cash increase","description":"Trigger a virtual cash increase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_virtual_cash_increase","name":"Trigger a virtual cash increase","isWebhook":false,"pointer":"/paths/~1virtual_cash_balances~1increases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a virtual cash increase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger a virtual cash increase"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["virtual_cash_balances:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1virtual_cash_balances~1increases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1106","exampleIds":["paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1106","exampleIds":["paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1virtual_cash_balances~1increases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/virtual_cash_balances/increases","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["virtual_cash_balances:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1106","exampleIds":["paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/virtual_cash_balances/increases","href":"virtual-cash-balances/create_virtual_cash_increase","openApiOperationId":"create_virtual_cash_increase","summary":"Trigger a virtual cash increase"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1106","exampleIds":["paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1106","exampleIds":["paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Virtual Cash Balances Increase","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1107","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_1107","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1virtual_cash_balances~1increases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_1107","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1107","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cash-balances/create_virtual_cash_increase"}],"panels":[]}]},"httpPath":"/virtual_cash_balances/increases"},{"label":"Trigger a virtual cash decrease","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-cash-balances/create_virtual_cash_decrease","routeSlug":"/api/virtual-cash-balances/create_virtual_cash_decrease","metadata":{"seo":{"title":"Trigger a virtual cash decrease","description":"Trigger a virtual cash decrease"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_virtual_cash_decrease","name":"Trigger a virtual cash decrease","isWebhook":false,"pointer":"/paths/~1virtual_cash_balances~1decreases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a virtual cash decrease","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger a virtual cash decrease"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["virtual_cash_balances:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1virtual_cash_balances~1decreases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1108","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1108","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1virtual_cash_balances~1decreases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/virtual_cash_balances/decreases","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["virtual_cash_balances:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1108","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401","403","404","406","429","500","503","504"],"pointer":"/virtual_cash_balances/decreases","href":"virtual-cash-balances/create_virtual_cash_decrease","openApiOperationId":"create_virtual_cash_decrease","summary":"Trigger a virtual cash decrease"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1108","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1108","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Virtual Cash Balances Decrease","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1109","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_1109","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1virtual_cash_balances~1decreases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_1109","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1109","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cash-balances/create_virtual_cash_decrease"}],"panels":[]}]},"httpPath":"/virtual_cash_balances/decreases"},{"label":"Cancel virtual cash decrease by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/virtual-cash-balances/cancel_virtual_cash_decrease","routeSlug":"/api/virtual-cash-balances/cancel_virtual_cash_decrease","metadata":{"seo":{"title":"Cancel virtual cash decrease by ID","description":"Cancels a virtual cash decrease specified by its ID. It is only possible to cancel a virtual cash decrease if it has the status ISSUED or QUEUED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_virtual_cash_decrease","name":"Cancel virtual cash decrease by ID","isWebhook":false,"pointer":"/paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel virtual cash decrease by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a virtual cash decrease specified by its ID. It is only possible to cancel a virtual cash decrease if it has the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISSUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["virtual_cash_balances:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtual_cash_decrease_id","in":"path","schemaId":"schema_1110","required":true}],"pointer":"/paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/virtual_cash_balances/decreases/{virtual_cash_decrease_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"virtual_cash_decrease_id","in":"path","required":true,"schemaId":"schema_1110"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["virtual_cash_balances:admin"]}],"responseCodes":["202","401","403","404","406","422","429","500","503","504"],"pointer":"/virtual_cash_balances/decreases/{virtual_cash_decrease_id}","href":"virtual-cash-balances/cancel_virtual_cash_decrease","openApiOperationId":"cancel_virtual_cash_decrease","summary":"Cancel virtual cash decrease by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The request has been successfully accepted and will be processed asynchronously.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"422","description":"Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example"]}}},{"code":"422","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cash-balances/cancel_virtual_cash_decrease"}],"panels":[]}]},"httpPath":"/virtual_cash_balances/decreases/{virtual_cash_decrease_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Virtual cash increase events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/virtual-cash-balances/virtual_cash_increase_event","routeSlug":"/api/virtual-cash-balances/virtual_cash_increase_event","metadata":{"seo":{"title":"Virtual cash increase events","description":"Virtual cash increase events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"virtual_cash_increase_event","name":"Virtual cash increase events","isWebhook":true,"pointer":"/paths/Virtual cash increase events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual cash increase events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Virtual cash increase events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1111","exampleIds":["paths/Virtual cash increase events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1111","exampleIds":["paths/Virtual cash increase events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Virtual cash increase events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Virtual cash increase events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1111","exampleIds":["paths/Virtual cash increase events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Virtual cash increase events","href":"virtual-cash-balances/virtual_cash_increase_event","openApiOperationId":"virtual_cash_increase_event","summary":"Virtual cash increase events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1111","exampleIds":["paths/Virtual cash increase events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1111","exampleIds":["paths/Virtual cash increase events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Virtual cash increase events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cash-balances/virtual_cash_increase_event"}],"panels":[]}]},"httpPath":"Virtual cash increase events"},{"label":"Virtual cash decrease events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/virtual-cash-balances/virtual_cash_decrease_event","routeSlug":"/api/virtual-cash-balances/virtual_cash_decrease_event","metadata":{"seo":{"title":"Virtual cash decrease events","description":"Virtual cash decrease events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"virtual_cash_decrease_event","name":"Virtual cash decrease events","isWebhook":true,"pointer":"/paths/Virtual cash decrease events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual cash decrease events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Virtual cash decrease events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1112","exampleIds":["paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1112","exampleIds":["paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Virtual cash decrease events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Virtual cash decrease events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1112","exampleIds":["paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Virtual cash decrease events","href":"virtual-cash-balances/virtual_cash_decrease_event","openApiOperationId":"virtual_cash_decrease_event","summary":"Virtual cash decrease events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1112","exampleIds":["paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1112","exampleIds":["paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Virtual cash decrease events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cash-balances/virtual_cash_decrease_event"}],"panels":[]}]},"httpPath":"Virtual cash decrease events"}],"content":{"contentType":"group","meta":{"name":"Virtual Cash Balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual Cash Balances","showPageActions":true},{"nodeType":"markdoc","content":"All virtual cash balances related paths"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/virtual_cash_balances/increases","summary":"Trigger a virtual cash increase","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cash-balances/create_virtual_cash_increase","deprecated":false},{"title":"/virtual_cash_balances/decreases","summary":"Trigger a virtual cash decrease","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cash-balances/create_virtual_cash_decrease","deprecated":false},{"title":"/virtual_cash_balances/decreases/{virtual_cash_decrease_id}","summary":"Cancel virtual cash decrease by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-cash-balances/cancel_virtual_cash_decrease","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Virtual cash increase events","summary":"Virtual cash increase events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cash-balances/virtual_cash_increase_event","deprecated":false},{"title":"Virtual cash decrease events","summary":"Virtual cash decrease events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cash-balances/virtual_cash_decrease_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Fees","content":null},{"type":"group","label":"Fees","link":"/api/fees","routeSlug":"/api/fees","items":[{"label":"Get fee collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/list_fee_collections","routeSlug":"/api/fees/list_fee_collections","metadata":{"seo":{"title":"Get fee collections","description":"Returns a list of fee collections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_fee_collections","name":"Get fee collections","isWebhook":false,"pointer":"/paths/~1fees~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fee collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of fee collections."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:read","fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_934","description":"Filters the list to show only fees associated with a specific account ID.","example":"413715f2-5401-4b97-8055-034a6b879f8c"},{"name":"account_group_id","in":"query","schemaId":"schema_944","description":"Filters the list to show only fees associated with a specific account group ID.","example":"72da9e41-9926-419f-976e-4c8069a04249"},{"name":"sort","in":"query","schemaId":"schema_886","description":"Field of resource to sort by.","example":"created_at"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1fees~1collections/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/collections","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","required":false,"example":"413715f2-5401-4b97-8055-034a6b879f8c","schemaId":"schema_934"},{"name":"account_group_id","in":"query","required":false,"example":"72da9e41-9926-419f-976e-4c8069a04249","schemaId":"schema_944"},{"name":"sort","in":"query","required":false,"example":"created_at","schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:read","fees:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/fees/collections","href":"fees/list_fee_collections","openApiOperationId":"list_fee_collections","summary":"Get fee collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1113","exampleIds":["paths/~1fees~1collections/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1113","exampleIds":["paths/~1fees~1collections/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1113","exampleIds":["paths/~1fees~1collections/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1113","exampleIds":["paths/~1fees~1collections/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/list_fee_collections"}],"panels":[]}]},"httpPath":"/fees/collections"},{"label":"Create a fee collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/create_fee_collection","routeSlug":"/api/fees/create_fee_collection","metadata":{"seo":{"title":"Create a fee collection","description":"Creates a fee collection for pre-calculated fee amounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_fee_collection","name":"Create a fee collection","isWebhook":false,"pointer":"/paths/~1fees~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a fee collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a fee collection for pre-calculated fee amounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1collections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1114","exampleIds":["paths/~1fees~1collections/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1114","exampleIds":["paths/~1fees~1collections/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1fees~1collections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fees/collections","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1114","exampleIds":["paths/~1fees~1collections/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/fees/collections","href":"fees/create_fee_collection","openApiOperationId":"create_fee_collection","summary":"Create a fee collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1114","exampleIds":["paths/~1fees~1collections/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1114","exampleIds":["paths/~1fees~1collections/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fee collection created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/create_fee_collection"}],"panels":[]}]},"httpPath":"/fees/collections"},{"label":"Get a fee collection by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/retrieve_fee_collection","routeSlug":"/api/fees/retrieve_fee_collection","metadata":{"seo":{"title":"Get a fee collection by ID","description":"Returns the fee collection specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_fee_collection","name":"Get a fee collection by ID","isWebhook":false,"pointer":"/paths/~1fees~1collections~1{fee_collection_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a fee collection by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the fee collection specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:read","fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fee_collection_id","in":"path","schemaId":"schema_1116","required":true}],"pointer":"/paths/~1fees~1collections~1{fee_collection_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1collections~1{fee_collection_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/collections/{fee_collection_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"fee_collection_id","in":"path","required":true,"schemaId":"schema_1116"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:read","fees:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/fees/collections/{fee_collection_id}","href":"fees/retrieve_fee_collection","openApiOperationId":"retrieve_fee_collection","summary":"Get a fee collection by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1collections~1{fee_collection_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1115","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/retrieve_fee_collection"}],"panels":[]}]},"httpPath":"/fees/collections/{fee_collection_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Fee collection events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/fees/fee_collection_event","routeSlug":"/api/fees/fee_collection_event","metadata":{"seo":{"title":"Fee collection events","description":"Fee collection events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fee_collection_event","name":"Fee collection events","isWebhook":true,"pointer":"/paths/Fee collection events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fee collection events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fee collection events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1117","exampleIds":["paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED","paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"]}},"schemaId":"schema_1117","exampleIds":["paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED","paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"],"pointer":"/paths/Fee collection events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Fee collection events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1117","exampleIds":["paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED","paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"]}},"responseCodes":["200"],"pointer":"Fee collection events","href":"fees/fee_collection_event","openApiOperationId":"fee_collection_event","summary":"Fee collection events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1117","exampleIds":["paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED","paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1117","exampleIds":["paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED","paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Fee collection events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/fee_collection_event"}],"panels":[]}]},"httpPath":"Fee collection events"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":"All fees related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees/collections","summary":"Get fee collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/list_fee_collections","deprecated":false},{"title":"/fees/collections","summary":"Create a fee collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/create_fee_collection","deprecated":false},{"title":"/fees/collections/{fee_collection_id}","summary":"Get a fee collection by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/retrieve_fee_collection","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Fee collection events","summary":"Fee collection events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/fee_collection_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees Configurations","link":"/api/fees-configurations","routeSlug":"/api/fees-configurations","items":[{"label":"Create a fee configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees-configurations/create_fee_configuration","routeSlug":"/api/fees-configurations/create_fee_configuration","metadata":{"seo":{"title":"Create a fee configuration","description":"Creates a fee configuration for a fee collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_fee_configuration","name":"Create a fee configuration","isWebhook":false,"pointer":"/paths/~1fees~1configurations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a fee configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a fee configuration for a fee collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1configurations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1118","exampleIds":["paths/~1fees~1configurations/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1118","exampleIds":["paths/~1fees~1configurations/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1fees~1configurations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fees/configurations","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1118","exampleIds":["paths/~1fees~1configurations/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","409","429","500","503","504"],"pointer":"/fees/configurations","href":"fees-configurations/create_fee_configuration","openApiOperationId":"create_fee_configuration","summary":"Create a fee configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1118","exampleIds":["paths/~1fees~1configurations/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1118","exampleIds":["paths/~1fees~1configurations/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1configurations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees-configurations/create_fee_configuration"}],"panels":[]}]},"httpPath":"/fees/configurations"},{"label":"Get fee configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees-configurations/retrieve_fee_configurations","routeSlug":"/api/fees-configurations/retrieve_fee_configurations","metadata":{"seo":{"title":"Get fee configuration","description":"Retrieve the fee configuration for a specific account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_fee_configurations","name":"Get fee configuration","isWebhook":false,"pointer":"/paths/~1fees~1configurations~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fee configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the fee configuration for a specific account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:read","fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1fees~1configurations~1{account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1configurations~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/configurations/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:read","fees:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/fees/configurations/{account_id}","href":"fees-configurations/retrieve_fee_configurations","openApiOperationId":"retrieve_fee_configurations","summary":"Get fee configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1configurations~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees-configurations/retrieve_fee_configurations"}],"panels":[]}]},"httpPath":"/fees/configurations/{account_id}"},{"label":"Update fee configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees-configurations/update_fee_configuration","routeSlug":"/api/fees-configurations/update_fee_configuration","metadata":{"seo":{"title":"Update fee configuration","description":"Update fee configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_fee_configuration","name":"Update fee configuration","isWebhook":false,"pointer":"/paths/~1fees~1configurations~1{account_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update fee configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update fee configuration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_934","required":true}],"pointer":"/paths/~1fees~1configurations~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1fees~1configurations~1{account_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1120","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_1120","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1fees~1configurations~1{account_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fees/configurations/{account_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_934"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["fees:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1120","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/fees/configurations/{account_id}","href":"fees-configurations/update_fee_configuration","openApiOperationId":"update_fee_configuration","summary":"Update fee configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1120","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1120","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1fees~1configurations~1{account_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees-configurations/update_fee_configuration"}],"panels":[]}]},"httpPath":"/fees/configurations/{account_id}"}],"content":{"contentType":"group","meta":{"name":"Fees Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees Configurations","showPageActions":true},{"nodeType":"markdoc","content":"All fees configurations related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees/configurations","summary":"Create a fee configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees-configurations/create_fee_configuration","deprecated":false},{"title":"/fees/configurations/{account_id}","summary":"Get fee configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees-configurations/retrieve_fee_configurations","deprecated":false},{"title":"/fees/configurations/{account_id}","summary":"Update fee configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fees-configurations/update_fee_configuration","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transaction Fees","content":null},{"type":"group","label":"Transaction Fees Models","link":"/api/transaction-fees-models","routeSlug":"/api/transaction-fees-models","items":[{"label":"List transaction fee models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transaction-fees-models/list_transaction_fee_models","routeSlug":"/api/transaction-fees-models/list_transaction_fee_models","metadata":{"seo":{"title":"List transaction fee models","description":"List transaction fee models."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_transaction_fee_models","name":"List transaction fee models","isWebhook":false,"pointer":"/paths/~1transaction_fees~1models/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transaction fee models","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List transaction fee models."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["transaction_fees:admin","transaction_fees:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1transaction_fees~1models/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1transaction_fees~1models/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transaction_fees/models","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["transaction_fees:admin","transaction_fees:read"]}],"responseCodes":["200","400","401","403","404","406","409","429","500","503","504"],"pointer":"/transaction_fees/models","href":"transaction-fees-models/list_transaction_fee_models","openApiOperationId":"list_transaction_fee_models","summary":"List transaction fee models"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1121","exampleIds":["paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models"]}},"schemaId":"schema_1121","exampleIds":["paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1transaction_fees~1models/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1121","exampleIds":["paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1121","exampleIds":["paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-fees-models/list_transaction_fee_models"}],"panels":[]}]},"httpPath":"/transaction_fees/models"},{"label":"Create a transaction fee model","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transaction-fees-models/create_transaction_fee_model","routeSlug":"/api/transaction-fees-models/create_transaction_fee_model","metadata":{"seo":{"title":"Create a transaction fee model","description":"Create a transaction fee model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_transaction_fee_model","name":"Create a transaction fee model","isWebhook":false,"pointer":"/paths/~1transaction_fees~1models/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transaction fee model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a transaction fee model."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["transaction_fees:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1transaction_fees~1models/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1122","exampleIds":["paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"]}},"schemaId":"schema_1122","exampleIds":["paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"],"pointer":"/paths/~1transaction_fees~1models/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transaction_fees/models","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["transaction_fees:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1122","exampleIds":["paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"]}},"responseCodes":["200","400","401","403","404","406","409","429","500","503","504"],"pointer":"/transaction_fees/models","href":"transaction-fees-models/create_transaction_fee_model","openApiOperationId":"create_transaction_fee_model","summary":"Create a transaction fee model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1122","exampleIds":["paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1122","exampleIds":["paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model"]}},"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1transaction_fees~1models/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model","paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-fees-models/create_transaction_fee_model"}],"panels":[]}]},"httpPath":"/transaction_fees/models"},{"label":"Get transaction fee model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transaction-fees-models/retrieve_transaction_fee_model","routeSlug":"/api/transaction-fees-models/retrieve_transaction_fee_model","metadata":{"seo":{"title":"Get transaction fee model","description":"Get transaction fee model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_transaction_fee_model","name":"Get transaction fee model","isWebhook":false,"pointer":"/paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction fee model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get transaction fee model."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["transaction_fees:admin","transaction_fees:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_fee_model_id","in":"path","schemaId":"schema_1124","description":"Transaction Fee Model ID","required":true}],"pointer":"/paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transaction_fees/models/{transaction_fee_model_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"transaction_fee_model_id","in":"path","required":true,"schemaId":"schema_1124"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["transaction_fees:admin","transaction_fees:read"]}],"responseCodes":["200","401","403","404","406","409","429","500","503","504"],"pointer":"/transaction_fees/models/{transaction_fee_model_id}","href":"transaction-fees-models/retrieve_transaction_fee_model","openApiOperationId":"retrieve_transaction_fee_model","summary":"Get transaction fee model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model"]}},"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"409","description":"Conflict. An operation is not available for the current state of the resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1123","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier","paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-fees-models/retrieve_transaction_fee_model"}],"panels":[]}]},"httpPath":"/transaction_fees/models/{transaction_fee_model_id}"}],"content":{"contentType":"group","meta":{"name":"Transaction Fees Models"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction Fees Models","showPageActions":true},{"nodeType":"markdoc","content":"All transaction fees models related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transaction_fees/models","summary":"List transaction fee models","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-fees-models/list_transaction_fee_models","deprecated":false},{"title":"/transaction_fees/models","summary":"Create a transaction fee model","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction-fees-models/create_transaction_fee_model","deprecated":false},{"title":"/transaction_fees/models/{transaction_fee_model_id}","summary":"Get transaction fee model","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-fees-models/retrieve_transaction_fee_model","deprecated":false}]}]}]}]}},{"type":"separator","label":"Reporting","content":null},{"type":"group","label":"Reports","link":"/api/reports","routeSlug":"/api/reports","items":[{"label":"List user reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/list_user_reports","routeSlug":"/api/reports/list_user_reports","metadata":{"seo":{"title":"List user reports","description":"List user reports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_user_reports","name":"List user reports","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List user reports"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reports:read","reports:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_895","required":true}],"pointer":"/paths/~1users~1{user_id}~1reports/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_1125","description":"Filters the list to only show reports of a certain type (e.g. only buy order confirmations)","example":"BUY_ORDER"},{"name":"instrument","in":"query","schemaId":"schema_1126","description":"Filters the list to only include reports concerning specified instrument"},{"name":"start_date","in":"query","schemaId":"schema_1127","example":"2020-08-21"},{"name":"end_date","in":"query","schemaId":"schema_1128","example":"2020-09-25"},{"name":"sort","in":"query","schemaId":"schema_1129","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}~1reports/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1users~1{user_id}~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}/reports","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_895"}],"query":[{"name":"type","in":"query","required":false,"example":"BUY_ORDER","schemaId":"schema_1125"},{"name":"instrument","in":"query","required":false,"example":"uuid:ebabcf4d-61c3-4942-875c-e265a7c2d062","schemaId":"schema_1126"},{"name":"start_date","in":"query","required":false,"example":"2020-08-21","schemaId":"schema_1127"},{"name":"end_date","in":"query","required":false,"example":"2020-09-25","schemaId":"schema_1128"},{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1129"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reports:read","reports:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/users/{user_id}/reports","href":"reports/list_user_reports","openApiOperationId":"list_user_reports","summary":"List user reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reports list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1130","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1130","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1users~1{user_id}~1reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1130","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1130","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/list_user_reports"}],"panels":[]}]},"httpPath":"/users/{user_id}/reports"},{"label":"Create a user report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/create_report","routeSlug":"/api/reports/create_report","metadata":{"seo":{"title":"Create a user report","description":"Create a user report"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_report","name":"Create a user report","isWebhook":false,"pointer":"/paths/~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a user report"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reports:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1reports/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1131","exampleIds":["paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"]}},"schemaId":"schema_1131","exampleIds":["paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"],"pointer":"/paths/~1reports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reports:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1131","exampleIds":["paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/reports","href":"reports/create_report","openApiOperationId":"create_report","summary":"Create a user report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1131","exampleIds":["paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1131","exampleIds":["paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost","paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1132","exampleIds":["paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost"]}},"schemaId":"schema_1132","exampleIds":["paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1132","exampleIds":["paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1132","exampleIds":["paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/create_report"}],"panels":[]}]},"httpPath":"/reports"},{"label":"Retrieve a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve_report","routeSlug":"/api/reports/retrieve_report","metadata":{"seo":{"title":"Retrieve a report","description":"Retrieve a report for either a natural person or a business entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_report","name":"Retrieve a report","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a report for either a natural person or a business entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reports:read","reports:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_1133","required":true}],"pointer":"/paths/~1reports~1{report_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_1134","description":"Report format"},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1reports~1{report_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_1133"}],"query":[],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_1134"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reports:read","reports:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/reports/{report_id}","href":"reports/retrieve_report","openApiOperationId":"retrieve_report","summary":"Retrieve a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1135","exampleIds":["paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report"]},"application/pdf":{"schemaId":"schema_1136"}},"schemaId":"schema_1135","exampleIds":["paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1reports~1{report_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1135","exampleIds":["paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report"],"mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1135","exampleIds":["paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report","paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report"]},"application/pdf":{"schemaId":"schema_1136"}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/retrieve_report"}],"panels":[]}]},"httpPath":"/reports/{report_id}"},{"label":"List business reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/list_business_reports","routeSlug":"/api/reports/list_business_reports","metadata":{"seo":{"title":"List business reports","description":"List business reports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_business_reports","name":"List business reports","isWebhook":false,"pointer":"/paths/~1businesses~1{business_id}~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List business reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List business reports"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["reports:read","reports:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_915","required":true}],"pointer":"/paths/~1businesses~1{business_id}~1reports/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_1125","description":"Filters the list to only show reports of a certain type (e.g. only buy order confirmations)","example":"BUY_ORDER"},{"name":"instrument","in":"query","schemaId":"schema_1126","description":"Filters the list to only include reports concerning specified instrument"},{"name":"start_date","in":"query","schemaId":"schema_1127","example":"2020-08-21"},{"name":"end_date","in":"query","schemaId":"schema_1128","example":"2020-09-25"},{"name":"sort","in":"query","schemaId":"schema_1045","description":"Field of resource to sort by","example":"id"},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]}],"pointer":"/paths/~1businesses~1{business_id}~1reports/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1businesses~1{business_id}~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businesses/{business_id}/reports","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_915"}],"query":[{"name":"type","in":"query","required":false,"example":"BUY_ORDER","schemaId":"schema_1125"},{"name":"instrument","in":"query","required":false,"example":"uuid:ebabcf4d-61c3-4942-875c-e265a7c2d062","schemaId":"schema_1126"},{"name":"start_date","in":"query","required":false,"example":"2020-08-21","schemaId":"schema_1127"},{"name":"end_date","in":"query","required":false,"example":"2020-09-25","schemaId":"schema_1128"},{"name":"sort","in":"query","required":false,"example":"id","schemaId":"schema_1045"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"offset","in":"query","schemaId":"schema_888"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["reports:read","reports:admin"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/businesses/{business_id}/reports","href":"reports/list_business_reports","openApiOperationId":"list_business_reports","summary":"List business reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reports list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1137","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1137","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1businesses~1{business_id}~1reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1137","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1137","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/list_business_reports"}],"panels":[]}]},"httpPath":"/businesses/{business_id}/reports"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Reports events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/reports/report_event","routeSlug":"/api/reports/report_event","metadata":{"seo":{"title":"Reports events","description":"Report events for either a natural person or a business entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_event","name":"Reports events","isWebhook":true,"pointer":"/paths/Reports events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report events for either a natural person or a business entity."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1138","exampleIds":["paths/Reports events/post/requestBody/content/application~1json/examples/user_report","paths/Reports events/post/requestBody/content/application~1json/examples/business_report"]}},"schemaId":"schema_1138","exampleIds":["paths/Reports events/post/requestBody/content/application~1json/examples/user_report","paths/Reports events/post/requestBody/content/application~1json/examples/business_report"],"pointer":"/paths/Reports events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Reports events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1138","exampleIds":["paths/Reports events/post/requestBody/content/application~1json/examples/user_report","paths/Reports events/post/requestBody/content/application~1json/examples/business_report"]}},"responseCodes":["200"],"pointer":"Reports events","href":"reports/report_event","openApiOperationId":"report_event","summary":"Reports events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1138","exampleIds":["paths/Reports events/post/requestBody/content/application~1json/examples/user_report","paths/Reports events/post/requestBody/content/application~1json/examples/business_report"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1138","exampleIds":["paths/Reports events/post/requestBody/content/application~1json/examples/user_report","paths/Reports events/post/requestBody/content/application~1json/examples/business_report"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Reports events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/report_event"}],"panels":[]}]},"httpPath":"Reports events"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"All reports related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/reports","summary":"List user reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/list_user_reports","deprecated":false},{"title":"/reports","summary":"Create a user report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/create_report","deprecated":false},{"title":"/reports/{report_id}","summary":"Retrieve a report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/retrieve_report","deprecated":false},{"title":"/businesses/{business_id}/reports","summary":"List business reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/list_business_reports","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Reports events","summary":"Reports events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/report_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Treasury Reports","link":"/api/treasury-reports","routeSlug":"/api/treasury-reports","items":[{"label":"Treasury reports events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/treasury-reports/treasury_report_event","routeSlug":"/api/treasury-reports/treasury_report_event","metadata":{"seo":{"title":"Treasury reports events","description":"Treasury reports events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"treasury_report_event","name":"Treasury reports events","isWebhook":true,"pointer":"/paths/Treasury reports events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Treasury reports events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Treasury reports events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1139","exampleIds":["paths/Treasury reports events/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1139","exampleIds":["paths/Treasury reports events/post/requestBody/content/application~1json/example"],"pointer":"/paths/Treasury reports events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Treasury reports events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1139","exampleIds":["paths/Treasury reports events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"Treasury reports events","href":"treasury-reports/treasury_report_event","openApiOperationId":"treasury_report_event","summary":"Treasury reports events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1139","exampleIds":["paths/Treasury reports events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1139","exampleIds":["paths/Treasury reports events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Treasury reports events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/treasury-reports/treasury_report_event"}],"panels":[]}]},"httpPath":"Treasury reports events"}],"content":{"contentType":"group","meta":{"name":"Treasury Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Treasury Reports","showPageActions":true},{"nodeType":"markdoc","content":"All treasury reports related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Treasury reports events","summary":"Treasury reports events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/treasury-reports/treasury_report_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/api/transactions","routeSlug":"/api/transactions","items":[{"label":"List cash transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transactions/list_cash_transactions","routeSlug":"/api/transactions/list_cash_transactions","metadata":{"seo":{"title":"List cash transactions","description":"List cash transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_cash_transactions","name":"List cash transactions","isWebhook":false,"pointer":"/paths/~1transactions~1cash/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List cash transactions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["transactions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_group_id","in":"query","schemaId":"schema_944","description":"Filters the list to show only transactions associated with a certain account group ID.","example":"413715f2-5401-4b97-8055-034a6b879f8c"},{"name":"start_date","in":"query","schemaId":"schema_1140"},{"name":"end_date","in":"query","schemaId":"schema_1141"},{"name":"sort","in":"query","schemaId":"schema_1142","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions~1cash/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1transactions~1cash/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/cash","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"account_group_id","in":"query","required":false,"example":"413715f2-5401-4b97-8055-034a6b879f8c","schemaId":"schema_944"},{"name":"start_date","in":"query","required":false,"example":"2023-01-03","schemaId":"schema_1140"},{"name":"end_date","in":"query","required":false,"example":"2023-01-11","schemaId":"schema_1141"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1142"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["transactions:read"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/transactions/cash","href":"transactions/list_cash_transactions","openApiOperationId":"list_cash_transactions","summary":"List cash transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash Transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1143","exampleIds":["paths/~1transactions~1cash/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1143","exampleIds":["paths/~1transactions~1cash/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1transactions~1cash/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1143","exampleIds":["paths/~1transactions~1cash/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1143","exampleIds":["paths/~1transactions~1cash/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/list_cash_transactions"}],"panels":[]}]},"httpPath":"/transactions/cash"},{"label":"List securities transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transactions/list_securities_transactions","routeSlug":"/api/transactions/list_securities_transactions","metadata":{"seo":{"title":"List securities transactions","description":"List securities transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_securities_transactions","name":"List securities transactions","isWebhook":false,"pointer":"/paths/~1transactions~1securities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List securities transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List securities transactions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["transactions:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_group_id","in":"query","schemaId":"schema_944","description":"Filters the list to only show transactions associated with a certain account group ID.","example":"413715f2-5401-4b97-8055-034a6b879f8c"},{"name":"account_id","in":"query","schemaId":"schema_934","description":"Filters the list to only show transactions associated with a certain account ID.","example":"413715f2-5401-4b97-8055-034a6b879f8c"},{"name":"start_date","in":"query","schemaId":"schema_1144","example":"2023-01-03"},{"name":"end_date","in":"query","schemaId":"schema_1141"},{"name":"sort","in":"query","schemaId":"schema_1142","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions~1securities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1transactions~1securities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/securities","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"account_group_id","in":"query","required":false,"example":"413715f2-5401-4b97-8055-034a6b879f8c","schemaId":"schema_944"},{"name":"account_id","in":"query","required":false,"example":"413715f2-5401-4b97-8055-034a6b879f8c","schemaId":"schema_934"},{"name":"start_date","in":"query","required":false,"example":"2023-01-03","schemaId":"schema_1144"},{"name":"end_date","in":"query","required":false,"example":"2023-01-11","schemaId":"schema_1141"},{"name":"sort","in":"query","required":false,"schemaId":"schema_1142"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["transactions:read"]}],"responseCodes":["200","400","401","403","404","405","406","429","500","503","504"],"pointer":"/transactions/securities","href":"transactions/list_securities_transactions","openApiOperationId":"list_securities_transactions","summary":"List securities transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Securities Transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1145","exampleIds":["paths/~1transactions~1securities/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1145","exampleIds":["paths/~1transactions~1securities/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"405","description":"Method Not Allowed. The requested method is not allowed on the requested resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1transactions~1securities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1145","exampleIds":["paths/~1transactions~1securities/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1145","exampleIds":["paths/~1transactions~1securities/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example"]}}},{"code":"405","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/list_securities_transactions"}],"panels":[]}]},"httpPath":"/transactions/securities"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Cash transactions events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/transactions/cash_transaction_event","routeSlug":"/api/transactions/cash_transaction_event","metadata":{"seo":{"title":"Cash transactions events","description":"Cash transactions events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cash_transaction_event","name":"Cash transactions events","isWebhook":true,"pointer":"/paths/Cash transactions events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash transactions events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cash transactions events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1146","exampleIds":["paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend","paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback","paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer","paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"]}},"schemaId":"schema_1146","exampleIds":["paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend","paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback","paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer","paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"],"pointer":"/paths/Cash transactions events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Cash transactions events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1146","exampleIds":["paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend","paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback","paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer","paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"]}},"responseCodes":["200"],"pointer":"Cash transactions events","href":"transactions/cash_transaction_event","openApiOperationId":"cash_transaction_event","summary":"Cash transactions events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1146","exampleIds":["paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend","paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback","paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer","paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1146","exampleIds":["paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend","paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest","paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection","paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit","paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback","paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal","paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation","paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer","paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Cash transactions events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/cash_transaction_event"}],"panels":[]}]},"httpPath":"Cash transactions events"},{"label":"Security transactions events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/transactions/security_transaction_event","routeSlug":"/api/transactions/security_transaction_event","metadata":{"seo":{"title":"Security transactions events","description":"Security transactions events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"security_transaction_event","name":"Security transactions events","isWebhook":true,"pointer":"/paths/Security transactions events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Security transactions events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Security transactions events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1147","exampleIds":["paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution","paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation","paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"]}},"schemaId":"schema_1147","exampleIds":["paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution","paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation","paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"],"pointer":"/paths/Security transactions events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Security transactions events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1147","exampleIds":["paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution","paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation","paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"]}},"responseCodes":["200"],"pointer":"Security transactions events","href":"transactions/security_transaction_event","openApiOperationId":"security_transaction_event","summary":"Security transactions events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1147","exampleIds":["paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution","paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation","paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1147","exampleIds":["paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution","paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation","paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Security transactions events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/security_transaction_event"}],"panels":[]}]},"httpPath":"Security transactions events"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"All transactions related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions/cash","summary":"List cash transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/list_cash_transactions","deprecated":false},{"title":"/transactions/securities","summary":"List securities transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/list_securities_transactions","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Cash transactions events","summary":"Cash transactions events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/cash_transaction_event","deprecated":false},{"title":"Security transactions events","summary":"Security transactions events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/security_transaction_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/api/files","routeSlug":"/api/files","items":[{"label":"Retrieve a file metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/fetching_file_metadata","routeSlug":"/api/files/fetching_file_metadata","metadata":{"seo":{"title":"Retrieve a file metadata","description":"Retrieve a file metadata"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetching_file_metadata","name":"Retrieve a file metadata","isWebhook":false,"pointer":"/paths/~1files~1{folder}~1{file_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a file metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a file metadata"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["files:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"folder","in":"path","schemaId":"schema_1148","description":"Files folder name","required":true},{"name":"file_name","in":"path","schemaId":"schema_1149","description":"Filename","required":true}],"pointer":"/paths/~1files~1{folder}~1{file_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"redirect","in":"query","schemaId":"schema_1150","description":"To enable HTTP redirect."}],"pointer":"/paths/~1files~1{folder}~1{file_name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1files~1{folder}~1{file_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{folder}/{file_name}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"folder","in":"path","required":true,"example":"booking_references","schemaId":"schema_1148"},{"name":"file_name","in":"path","required":true,"example":"list.txt","schemaId":"schema_1149"}],"query":[{"name":"redirect","in":"query","required":false,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["files:read"]}],"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/files/{folder}/{file_name}","href":"files/fetching_file_metadata","openApiOperationId":"fetching_file_metadata","summary":"Retrieve a file metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a files metadata object if a valid name and folder are provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1151","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1151","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1files~1{folder}~1{file_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1151","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1151","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/fetching_file_metadata"}],"panels":[]}]},"httpPath":"/files/{folder}/{file_name}"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"All files API related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files/{folder}/{file_name}","summary":"Retrieve a file metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/fetching_file_metadata","deprecated":false}]}]}]}]}},{"type":"separator","label":"Securities Transfers","content":null},{"type":"group","label":"Account Transfers","link":"/api/account-transfers","routeSlug":"/api/account-transfers","items":[{"label":"Create account transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-transfers/create_account_transfer","routeSlug":"/api/account-transfers/create_account_transfer","metadata":{"seo":{"title":"Create account transfer","description":"Create account transfer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_account_transfer","name":"Create account transfer","isWebhook":false,"pointer":"/paths/~1account_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create account transfer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_transfers:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1152","exampleIds":["paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"]}},"schemaId":"schema_1152","exampleIds":["paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"],"pointer":"/paths/~1account_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_transfers:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1152","exampleIds":["paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/account_transfers","href":"account-transfers/create_account_transfer","openApiOperationId":"create_account_transfer","summary":"Create account transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1152","exampleIds":["paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1152","exampleIds":["paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Transfer created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing"]}},"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1153","exampleIds":["paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-transfers/create_account_transfer"}],"panels":[]}]},"httpPath":"/account_transfers"},{"label":"Retrieve account transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-transfers/retrieve_account_transfer","routeSlug":"/api/account-transfers/retrieve_account_transfer","metadata":{"seo":{"title":"Retrieve account transfer","description":"Retrieve account transfer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account_transfer","name":"Retrieve account transfer","isWebhook":false,"pointer":"/paths/~1account_transfers~1{account_transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve account transfer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["account_transfers:admin","account_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_transfer_id","in":"path","schemaId":"schema_1154","required":true}],"pointer":"/paths/~1account_transfers~1{account_transfer_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1account_transfers~1{account_transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_transfers/{account_transfer_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"account_transfer_id","in":"path","required":true,"schemaId":"schema_1154"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["account_transfers:admin","account_transfers:read"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/account_transfers/{account_transfer_id}","href":"account-transfers/retrieve_account_transfer","openApiOperationId":"retrieve_account_transfer","summary":"Retrieve account transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Transfer object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing"]}},"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1account_transfers~1{account_transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1153","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1153","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming","paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-transfers/retrieve_account_transfer"}],"panels":[]}]},"httpPath":"/account_transfers/{account_transfer_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Account Transfer events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/account-transfers/account_transfer_event","routeSlug":"/api/account-transfers/account_transfer_event","metadata":{"seo":{"title":"Account Transfer events","description":"Account Transfer events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_transfer_event","name":"Account Transfer events","isWebhook":true,"pointer":"/paths/Account Transfers events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Transfer events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Account Transfer events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"]}},"schemaId":"schema_1155","exampleIds":["paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"],"pointer":"/paths/Account Transfers events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Account Transfers events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"]}},"responseCodes":["200"],"pointer":"Account Transfers events","href":"account-transfers/account_transfer_event","openApiOperationId":"account_transfer_event","summary":"Account Transfer events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1155","exampleIds":["paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled","paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"]}},"examples":[{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Account Transfers events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-transfers/account_transfer_event"}],"panels":[]}]},"httpPath":"Account Transfers events"}],"content":{"contentType":"group","meta":{"name":"Account Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Transfers","showPageActions":true},{"nodeType":"markdoc","content":"All Accounts Transfers related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_transfers","summary":"Create account transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-transfers/create_account_transfer","deprecated":false},{"title":"/account_transfers/{account_transfer_id}","summary":"Retrieve account transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-transfers/retrieve_account_transfer","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Account Transfers events","summary":"Account Transfer events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-transfers/account_transfer_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Securities Transfers","link":"/api/securities-transfers","routeSlug":"/api/securities-transfers","items":[{"label":"List securities transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/securities-transfers/list_securities_transfers","routeSlug":"/api/securities-transfers/list_securities_transfers","metadata":{"seo":{"title":"List securities transfers","description":"List securities transfers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_securities_transfers","name":"List securities transfers","isWebhook":false,"pointer":"/paths/~1securities_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List securities transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List securities transfers"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["securities_transfers:admin","securities_transfers:read"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direction","in":"query","schemaId":"schema_1156","description":"Filter the list by transfer direction.","required":true},{"name":"sort","in":"query","schemaId":"schema_886","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]},{"name":"user_id","in":"query","schemaId":"schema_895"},{"name":"account_id","in":"query","schemaId":"schema_934"},{"name":"account_group_id","in":"query","schemaId":"schema_944"},{"name":"status","in":"query","schemaId":"schema_1157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Securities transfer was cancelled."},"children":[]}]}]}]}]}],"pointer":"/paths/~1securities_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1securities_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/securities_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"direction","in":"query","required":true,"schemaId":"schema_1156"},{"name":"sort","in":"query","required":false,"schemaId":"schema_886"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_895"},{"name":"account_id","in":"query","required":false,"schemaId":"schema_934"},{"name":"account_group_id","in":"query","required":false,"schemaId":"schema_944"},{"name":"status","in":"query","required":false,"schemaId":"schema_1157"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["securities_transfers:admin","securities_transfers:read"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/securities_transfers","href":"securities-transfers/list_securities_transfers","openApiOperationId":"list_securities_transfers","summary":"List securities transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Securities Transfers list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1158","exampleIds":["paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing"]}},"schemaId":"schema_1158","exampleIds":["paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1securities_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1158","exampleIds":["paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1158","exampleIds":["paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/securities-transfers/list_securities_transfers"}],"panels":[]}]},"httpPath":"/securities_transfers"},{"label":"Create securities transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/securities-transfers/create_securities_transfer","routeSlug":"/api/securities-transfers/create_securities_transfer","metadata":{"seo":{"title":"Create securities transfer","description":"Create securities transfer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_securities_transfer","name":"Create securities transfer","isWebhook":false,"pointer":"/paths/~1securities_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create securities transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create securities transfer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["securities_transfers:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1securities_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1159","exampleIds":["paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"]}},"schemaId":"schema_1159","exampleIds":["paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"],"pointer":"/paths/~1securities_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/securities_transfers","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["securities_transfers:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1159","exampleIds":["paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/securities_transfers","href":"securities-transfers/create_securities_transfer","openApiOperationId":"create_securities_transfer","summary":"Create securities transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1159","exampleIds":["paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1159","exampleIds":["paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing","paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Securities Transfer created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1160","exampleIds":["paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing"]}},"schemaId":"schema_1160","exampleIds":["paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1securities_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1160","exampleIds":["paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1160","exampleIds":["paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming","paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/securities-transfers/create_securities_transfer"}],"panels":[]}]},"httpPath":"/securities_transfers"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Securities Transfers events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/securities-transfers/securities_transfer_event","routeSlug":"/api/securities-transfers/securities_transfer_event","metadata":{"seo":{"title":"Securities Transfers events","description":"Securities Transfers events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"securities_transfer_event","name":"Securities Transfers events","isWebhook":true,"pointer":"/paths/Securities Transfers events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Securities Transfers events","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Securities Transfers events"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"]}},"schemaId":"schema_1161","exampleIds":["paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"],"pointer":"/paths/Securities Transfers events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"Securities Transfers events","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"]}},"responseCodes":["200"],"pointer":"Securities Transfers events","href":"securities-transfers/securities_transfer_event","openApiOperationId":"securities_transfer_event","summary":"Securities Transfers events"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1161","exampleIds":["paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new","paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully."}],"pointer":"/paths/Securities Transfers events/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/securities-transfers/securities_transfer_event"}],"panels":[]}]},"httpPath":"Securities Transfers events"}],"content":{"contentType":"group","meta":{"name":"Securities Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Securities Transfers","showPageActions":true},{"nodeType":"markdoc","content":"All Securities Transfers related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/securities_transfers","summary":"List securities transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/securities-transfers/list_securities_transfers","deprecated":false},{"title":"/securities_transfers","summary":"Create securities transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/securities-transfers/create_securities_transfer","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"Securities Transfers events","summary":"Securities Transfers events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/securities-transfers/securities_transfer_event","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Webhook Subscriptions","link":"/api/webhook-subscriptions","routeSlug":"/api/webhook-subscriptions","items":[{"label":"Get signing keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/get_jwks","routeSlug":"/api/webhook-subscriptions/get_jwks","metadata":{"seo":{"title":"Get signing keys","description":"Returns a list of signing keys used to verify webhooks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_jwks","name":"Get signing keys","isWebhook":false,"pointer":"/paths/~1auth~1verify_keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get signing keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of signing keys used to verify webhooks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:read","webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1auth~1verify_keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/verify_keys","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:read","webhooks:admin"]}],"responseCodes":["200","401","403","406","429","500","503","504"],"pointer":"/auth/verify_keys","href":"webhook-subscriptions/get_jwks","openApiOperationId":"get_jwks","summary":"Get signing keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWKS signing public keys","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1162","exampleIds":["paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1162","exampleIds":["paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1auth~1verify_keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1162","exampleIds":["paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1162","exampleIds":["paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/get_jwks"}],"panels":[]}]},"httpPath":"/auth/verify_keys"},{"label":"List all webhook subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/list_webhooks","routeSlug":"/api/webhook-subscriptions/list_webhooks","metadata":{"seo":{"title":"List all webhook subscriptions","description":"Returns a list of all webhook subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_webhooks","name":"List all webhook subscriptions","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all webhook subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all webhook subscriptions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:read","webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_1163","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort the result by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_887","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order of the result list if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is specified. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending sort order."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_888","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify where in the list of results to start when returning items for a particular query."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_889","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" argument to specify the maximum number of items returned."},"children":[]}]}]}]}],"pointer":"/paths/~1webhooks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_1163"},{"name":"order","in":"query","required":false,"schemaId":"schema_887"},{"name":"offset","in":"query","schemaId":"schema_888"},{"name":"limit","in":"query","schemaId":"schema_889"}],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:read","webhooks:admin"]}],"responseCodes":["200","400","401","403","406","429","500","503","504"],"pointer":"/webhooks","href":"webhook-subscriptions/list_webhooks","openApiOperationId":"list_webhooks","summary":"List all webhook subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An object with a data property that contains an array of webhook subscription objects.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1164","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1164","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1164","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1164","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/list_webhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Create a webhook subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/create_webhook","routeSlug":"/api/webhook-subscriptions/create_webhook","metadata":{"seo":{"title":"Create a webhook subscription","description":"Creates a webhook subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_webhook","name":"Create a webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a webhook subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","406","429","500","503","504"],"pointer":"/webhooks","href":"webhook-subscriptions/create_webhook","openApiOperationId":"create_webhook","summary":"Create a webhook subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Returns a webhook subscription object if a valid webhook subscription object ID was provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_1166","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_1166","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/create_webhook"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Retrieve a webhook subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/retrieve_webhook","routeSlug":"/api/webhook-subscriptions/retrieve_webhook","metadata":{"seo":{"title":"Retrieve a webhook subscription","description":"Returns a webhook subscription specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_webhook","name":"Retrieve a webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a webhook subscription specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:read","webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_1167","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{webhook_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"schema_1167"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:read","webhooks:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/webhooks/{webhook_id}","href":"webhook-subscriptions/retrieve_webhook","openApiOperationId":"retrieve_webhook","summary":"Retrieve a webhook subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a webhook subscription object if a valid webhook subscription object ID was provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/retrieve_webhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}"},{"label":"Delete a webhook subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/delete_webhook","routeSlug":"/api/webhook-subscriptions/delete_webhook","metadata":{"seo":{"title":"Delete a webhook subscription","description":"Deletes a webhook subscription specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_webhook","name":"Delete a webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a webhook subscription specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_1167","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{webhook_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks~1{webhook_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{webhook_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"schema_1167"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:admin"]}],"responseCodes":["204","401","403","404","429","500","503","504"],"pointer":"/webhooks/{webhook_id}","href":"webhook-subscriptions/delete_webhook","openApiOperationId":"delete_webhook","summary":"Delete a webhook subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Request has been processed successfully.","headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks~1{webhook_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/delete_webhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}"},{"label":"Update a webhook subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/update_webhook","routeSlug":"/api/webhook-subscriptions/update_webhook","metadata":{"seo":{"title":"Update a webhook subscription","description":"Updates a webhook subscription specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_webhook","name":"Update a webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a webhook subscription specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_1167","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{webhook_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks~1{webhook_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1168","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_1168","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1webhooks~1{webhook_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/{webhook_id}","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"schema_1167"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1168","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/webhooks/{webhook_id}","href":"webhook-subscriptions/update_webhook","openApiOperationId":"update_webhook","summary":"Update a webhook subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1168","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1168","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a webhook subscription object if a valid webhook subscription object ID was provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks~1{webhook_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1166","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/update_webhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}"},{"label":"Test a webhook subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhook-subscriptions/test_webhook","routeSlug":"/api/webhook-subscriptions/test_webhook","metadata":{"seo":{"title":"Test a webhook subscription","description":"Tests a webhook subscription specified by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"test_webhook","name":"Test a webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}~1test/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test a webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tests a webhook subscription specified by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["webhooks:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_1167","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{webhook_id}~1test/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1webhooks~1{webhook_id}~1test/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks/{webhook_id}/test","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"schema_1167"}],"query":[],"querystring":[],"header":[{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["webhooks:admin"]}],"responseCodes":["200","401","403","404","406","429","500","503","504"],"pointer":"/webhooks/{webhook_id}/test","href":"webhook-subscriptions/test_webhook","openApiOperationId":"test_webhook","summary":"Test a webhook subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1169","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1169","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1webhooks~1{webhook_id}~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1169","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1169","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-subscriptions/test_webhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}/test"}],"content":{"contentType":"group","meta":{"name":"Webhook Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"All webhook subscriptions related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/verify_keys","summary":"Get signing keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook-subscriptions/get_jwks","deprecated":false},{"title":"/webhooks","summary":"List all webhook subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook-subscriptions/list_webhooks","deprecated":false},{"title":"/webhooks","summary":"Create a webhook subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-subscriptions/create_webhook","deprecated":false},{"title":"/webhooks/{webhook_id}","summary":"Retrieve a webhook subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook-subscriptions/retrieve_webhook","deprecated":false},{"title":"/webhooks/{webhook_id}","summary":"Delete a webhook subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook-subscriptions/delete_webhook","deprecated":false},{"title":"/webhooks/{webhook_id}","summary":"Update a webhook subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhook-subscriptions/update_webhook","deprecated":false},{"title":"/webhooks/{webhook_id}/test","summary":"Test a webhook subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-subscriptions/test_webhook","deprecated":false}]}]}]}]}},{"type":"separator","label":"Tests","content":null},{"type":"group","label":"Tests","link":"/api/tests","routeSlug":"/api/tests","items":[{"label":"Trigger a bank transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/tests/create_bank_transaction","routeSlug":"/api/tests/create_bank_transaction","metadata":{"seo":{"title":"Trigger a bank transaction","description":"Trigger a bank transaction for testing purposes. This can be used to simulate a money transfer for various flows which need cash settlements on one of our bank accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_bank_transaction","name":"Trigger a bank transaction","isWebhook":false,"pointer":"/paths/~1tests~1payments~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a bank transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger a bank transaction for testing purposes. This can be used to simulate a money transfer for various flows which need cash settlements on one of our bank accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth-client-credentials","scopes":["tests:admin"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-key","in":"header","schemaId":"schema_892","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID to be used as an idempotency key.  This prevents a duplicate request from being replayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.upvest.co/documentation/concepts/api_concepts/idempotency"},"children":[]}]}]}],"required":true},{"name":"upvest-client-id","in":"header","schemaId":"schema_879","description":"Tenant Client ID","required":true},{"name":"Authorization","in":"header","schemaId":"schema_890","description":"Bearer (access) token from the OAuth flow with correct scopes.\nhttps://datatracker.ietf.org/doc/html/rfc6750\n","required":true},{"name":"signature","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header"},"children":[]}]}]}],"required":true},{"name":"signature-input","in":"header","schemaId":"schema_880","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he"},"children":[]}]}]}],"required":true},{"name":"upvest-api-version","in":"header","schemaId":"schema_881","description":"Upvest API version (Note: Do not include quotation marks)"}],"pointer":"/paths/~1tests~1payments~1transactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1170","exampleIds":["paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1170","exampleIds":["paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1tests~1payments~1transactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tests/payments/transactions","servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-key","in":"header","required":true,"example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c","schemaId":"schema_892"},{"name":"upvest-client-id","in":"header","required":true,"example":"363f3305-7ab0-4e82-a158-f9d382ad08b6","schemaId":"schema_879"},{"name":"Authorization","in":"header","required":true,"example":"Bearer c2VjcmV0Cg==","schemaId":"schema_890"},{"name":"signature","in":"header","required":true,"schemaId":"schema_880"},{"name":"signature-input","in":"header","required":true,"schemaId":"schema_880"},{"name":"upvest-api-version","in":"header","required":false,"example":"1","schemaId":"schema_881"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}],"scopes":["tests:admin"]}],"requestBody":{"application/json":{"schemaId":"schema_1170","exampleIds":["paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","406","429","500","503","504"],"pointer":"/tests/payments/transactions","href":"tests/create_bank_transaction","openApiOperationId":"create_bank_transaction","summary":"Trigger a bank transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}],"schemaId":"schema_1170","exampleIds":["paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1170","exampleIds":["paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bank Transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1171","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1171","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"400","description":"Bad Request. The incoming request had a malformed parameter/object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"401","description":"Unauthorized. The caller has not been authenticated.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"403","description":"Forbidden. The caller has been authenticated but is not allowed to take the requested action.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"404","description":"Not Found. The requested resource could not be found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"406","description":"Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. \"Accept\" header defined unsupported value.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"429","description":"Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"500","description":"Internal Server Error. The service encountered an unexpected error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"503","description":"Service Unavailable. The service handling for this request cannot be reached at this time.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"},{"code":"504","description":"Gateway Timeout. The service gateway has reached its internal timeout.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example"]}},"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example"],"headers":{"upvest-request-id":{"required":true,"schema":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}}},"headerSchemaId":"schema_884"}],"pointer":"/paths/~1tests~1payments~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1171","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1171","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example"]}}},{"code":"406","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example"]}}},{"code":"503","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example"]}}},{"code":"504","schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_885","exampleIds":["paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tests/create_bank_transaction"}],"panels":[]}]},"httpPath":"/tests/payments/transactions"}],"content":{"contentType":"group","meta":{"name":"Tests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tests","showPageActions":true},{"nodeType":"markdoc","content":"All test related paths."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tests/payments/transactions","summary":"Trigger a bank transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tests/create_bank_transaction","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_879":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"363f3305-7ab0-4e82-a158-f9d382ad08b6"},"id":"schema_879"},"schema_880":{"kind":"json-schema","data":{"type":"string"},"id":"schema_880"},"schema_881":{"kind":"json-schema","data":{"type":"string","enum":["1"],"default":"1","example":"1"},"id":"schema_881"},"schema_882":{"kind":"json-schema","data":{"title":"Request - Auth - Request Access Token","type":"object","description":"Schema for access token request.","properties":{"client_id":{"type":"string","format":"uuid","description":"Client ID given during onboarding."},"client_secret":{"type":"string","maxLength":1000,"description":"Client Secret given during onboarding."},"grant_type":{"type":"string","default":"client_credentials","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"scope":{"type":"string","maxLength":1000,"description":"List of space delimited scopes to request for this access token."}},"required":["client_id","client_secret","grant_type","scope"],"additionalProperties":false},"id":"schema_882"},"schema_883":{"kind":"json-schema","data":{"title":"Auth - Access Token","type":"object","description":"Schema for an access token response.","properties":{"access_token":{"type":"string","maxLength":1000,"description":"The generated access token."},"expires_in":{"type":"integer","description":"How many seconds the access token is valid for."},"token_type":{"type":"string","default":"bearer","description":"This is always 'bearer'."},"scope":{"type":"string","maxLength":1000,"description":"List of space delimited scopes requested for this access token."}},"required":["access_token","expires_in","token_type","scope"],"additionalProperties":false},"id":"schema_883"},"schema_884":{"kind":"json-schema","data":{"type":"object","properties":{"upvest-request-id":{"type":"string","format":"uuid","example":"169ae4c7-ebd7-4041-94da-25369653eba7"}},"required":["upvest-request-id"]},"id":"schema_884"},"schema_885":{"kind":"json-schema","data":{"title":"Error","type":"object","description":"","properties":{"type":{"type":"string","description":"URL to a document describing the error condition."},"status":{"type":"integer","description":"Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers."},"title":{"type":"string","description":"A short, human-readable title for the general error type; the title should not change for given types."},"detail":{"type":"string","description":"A human-readable description of the specific error."},"instance":{"type":"string","description":"This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response."},"request_id":{"type":"string","description":"Correlation ID for the original request."}},"required":["type","status"],"additionalProperties":false},"id":"schema_885"},"schema_886":{"kind":"json-schema","data":{"type":"string","enum":["created_at","updated_at"],"default":"created_at"},"id":"schema_886"},"schema_887":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"],"default":"ASC"},"id":"schema_887"},"schema_888":{"kind":"json-schema","data":{"type":"integer","minimum":0,"format":"int32"},"id":"schema_888"},"schema_889":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":100,"minimum":1,"maximum":1000},"id":"schema_889"},"schema_890":{"kind":"json-schema","data":{"type":"string","pattern":"^Bearer [a-zA-Z0-9\\-\\._~+/]*=*","example":"Bearer c2VjcmV0Cg=="},"id":"schema_890"},"schema_891":{"kind":"json-schema","data":{"title":"Users - List - Response","type":"object","description":"","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"oneOf":[{"anyOf":[{"title":"Users (BYOL) - List","type":"array","minItems":1,"items":{"title":"User (BYOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false}},{"title":"Users (TOL) - List","type":"array","minItems":1,"items":{"title":"User (TOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fatca":{"type":"object","properties":{"status":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false."},"children":[]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user confirmed their FATCA status. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["status","confirmed_at"]},"terms_and_conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions will be needed for all users unless they are a child user or only a user on a business."},"children":[]}]}]}],"type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the terms & conditions. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"data_privacy_and_sharing_agreement":{"description":"Data privacy agreement will be needed for all users unless they are a child user or only a user on a business.","type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the data sharing agreement. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false}}]},{"title":"empty Users - List","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For empty lists, JSON schema's 'oneOf' matches both 'Users (BYOL) - List' "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 'Users (TOL) - List' and hence fails. So we need this extra 'oneOf' branch specifically for empty lists, distinguished by 'minItems' and 'maxItems'."},"children":[]}]}]}],"type":"array","maxItems":0,"items":{"description":"All items on list responses must be objects.","type":"object","properties":{}}}]}},"required":["meta","data"],"additionalProperties":false},"id":"schema_891"},"schema_892":{"kind":"json-schema","data":{"type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$","example":"ccb07f42-4104-44ad-8e1f-c660bb7b269c"},"id":"schema_892"},"schema_893":{"kind":"json-schema","data":{"title":"User - Create - Request","anyOf":[{"title":"User (BYOL) - Create - Request","type":"object","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["first_name","last_name","birth_date","nationalities","address"],"additionalProperties":false},{"title":"User (TOL) - Create - Request","type":"object","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"allOf":[{"title":"City name","type":"string","minLength":1,"maxLength":85},{"description":"This field is required except for users of UK TOL"}]},"birth_country":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required except for users of UK TOL"},"children":[]}]}]}]}]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"fatca":{"type":"object","properties":{"status":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false."},"children":[]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user confirmed their FATCA status. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["status","confirmed_at"]},"terms_and_conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions will be needed for all users unless they are a child user or only a user on a business."},"children":[]}]}]}],"type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the terms & conditions. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"data_privacy_and_sharing_agreement":{"description":"Data privacy agreement will be needed for all users unless they are a child user or only a user on a business.","type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the data sharing agreement. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["first_name","last_name","email","birth_date","nationalities","address","fatca"],"additionalProperties":false}]},"id":"schema_893"},"schema_894":{"kind":"json-schema","data":{"title":"User - Create - Request","anyOf":[{"title":"User (BYOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false},{"title":"User (TOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fatca":{"type":"object","properties":{"status":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false."},"children":[]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user confirmed their FATCA status. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["status","confirmed_at"]},"terms_and_conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions will be needed for all users unless they are a child user or only a user on a business."},"children":[]}]}]}],"type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the terms & conditions. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"data_privacy_and_sharing_agreement":{"description":"Data privacy agreement will be needed for all users unless they are a child user or only a user on a business.","type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the data sharing agreement. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false}]},"id":"schema_894"},"schema_895":{"kind":"json-schema","data":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"id":"schema_895"},"schema_896":{"kind":"json-schema","data":{"title":"User - Get - Response","anyOf":[{"title":"User (BYOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false},{"title":"User (TOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fatca":{"type":"object","properties":{"status":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false."},"children":[]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user confirmed their FATCA status. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["status","confirmed_at"]},"terms_and_conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions will be needed for all users unless they are a child user or only a user on a business."},"children":[]}]}]}],"type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the terms & conditions. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"data_privacy_and_sharing_agreement":{"description":"Data privacy agreement will be needed for all users unless they are a child user or only a user on a business.","type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the data sharing agreement. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false}]},"id":"schema_896"},"schema_897":{"kind":"json-schema","data":{"title":"User - Data Change - Request","anyOf":[{"title":"User (BYOL) - Data Change Request","type":"object","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name of the user."},"last_name":{"type":"string","maxLength":100,"minLength":2,"description":"Last name of the user."},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"minProperties":1,"additionalProperties":false},{"title":"User (TOL) - Data Change Request","oneOf":[{"type":"object","title":"User (TOL) - Data Change Request: Name change","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"issuance_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuance date in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the document proving the data change. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used to prove the data change"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD"]}},"required":["first_name","last_name","issuance_date","data_download_link","document_type"],"additionalProperties":false},{"type":"object","title":"User (TOL) - Data Change Request: Other","properties":{"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"minProperties":1,"additionalProperties":false},{"type":"object","title":"User (TOL) - Data Change Request: Nationality","properties":{"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"issuance_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuance date in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the document proving the data change. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used to prove the data change"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD"]}},"required":["nationalities","issuance_date","data_download_link","document_type"],"additionalProperties":false},{"type":"object","title":"User (TOL) - Data Change Request: Address","properties":{"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"issuance_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuance date in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the document proving the data change. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used to proof data change"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY_BILL - Utility bill"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TELEPHONE_BILL - Telephone bill"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNET_BILL - Internet bill"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_STATEMENT - Bank statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGISTRATION_CERT - Registration certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT - Residence permit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]}]}],"enum":["UTILITY_BILL","TELEPHONE_BILL","INTERNET_BILL","BANK_STATEMENT","REGISTRATION_CERT","RESIDENCE_PERMIT","ID_CARD"]}},"required":["address","issuance_date","data_download_link","document_type"],"additionalProperties":false}]}]},"id":"schema_897"},"schema_898":{"kind":"json-schema","data":{"title":"Webhook - Users - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["USER.CREATED","USER.ACTIVATED","USER.DEACTIVATED","USER.DATA_CHANGED","USER.DATA_CHANGE_FAILED","USER.OFFBOARDING_INITIATED","USER.OFFBOARDED"]},"object":{"oneOf":[{"anyOf":[{"title":"User (BYOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false},{"title":"User (TOL)","type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name(s) of the user. Please include all first and middle names of the user."},"last_name":{"type":"string","maxLength":100,"minLength":1,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"birth_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birth date of the user in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"birth_city":{"title":"City name","type":"string","minLength":1,"maxLength":85},"birth_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"birth_name":{"type":"string","maxLength":100,"description":"If applicable, birth name of the user."},"nationalities":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nationalities of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"postal_address":{"description":"User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.","oneOf":[{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"]},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of the user. Must be a valid email address."},"phone_number":{"type":"string","pattern":"^([0-9]{8,15})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the user. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number E.164 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fatca":{"type":"object","properties":{"status":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false."},"children":[]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user confirmed their FATCA status. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["status","confirmed_at"]},"terms_and_conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions will be needed for all users unless they are a child user or only a user on a business."},"children":[]}]}]}],"type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the terms & conditions. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"data_privacy_and_sharing_agreement":{"description":"Data privacy agreement will be needed for all users unless they are a child user or only a user on a business.","type":"object","properties":{"consent_document_id":{"title":"Consent unique identifier.","type":"string","description":"Consent unique identifier.","format":"uuid"},"confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the user consented to the data sharing agreement. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["consent_document_id","confirmed_at"]},"branch_id":{"title":"Branch unique identifier.","type":"string","description":"Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly","format":"uuid"},"gender":{"title":"Gender","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the user. Required for users applying for the German pension government bonus."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVERSE -"},"children":[]}]}]}]}],"enum":["","MALE","FEMALE","DIVERSE"],"default":""},"social_security_number":{"title":"Social security number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's assigned social security number (German social insurance number, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25300972S014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required for users applying for the German pension government bonus."},"children":[]}]}]}],"pattern":"^(\\d{2}(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[A-Z]\\d{3})?$"}},"required":["id","created_at","updated_at","first_name","last_name","birth_date","nationalities","address","status"],"additionalProperties":false}]},{"title":"Webhook - Users - Callback","type":"object","properties":{"user_id":{"type":"string","format":"uuid","description":"Event unique identifier"},"reason":{"type":"string","maxLength":100,"description":"The reason why the data change failed."}},"required":["user_id","reason"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_898"},"schema_899":{"kind":"json-schema","data":{"title":"Identifiers - List - Response","type":"object","properties":{"data":{"type":"array","items":{"title":"Identifier","type":"object","properties":{"id":{"title":"Unique identifier for the user's national ID.","type":"string","description":"Unique identifier for the user's national ID.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"identifier_standard":{"type":"string","maxLength":6,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to submit a CONCAT identifier. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]},"identifier":{"type":"string","maxLength":30,"minLength":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier value. Omit this field when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the value is generated by Upvest from the user's name and date of birth. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NATIONAL_ID -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["NATIONAL_ID","PASSPORT"],"default":"NATIONAL_ID"},"issuing_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["id","user_id","created_at","updated_at","identifier_standard","identifier","type","issuing_country"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false},"id":"schema_899"},"schema_900":{"kind":"json-schema","data":{"title":"Identifier - Create - Request","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NATIONAL_ID -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["NATIONAL_ID","PASSPORT"],"default":"NATIONAL_ID"},"issuing_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"identifier":{"type":"string","maxLength":30,"minLength":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier value. Omit this field when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the value is generated by Upvest from the user's name and date of birth. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]},"identifier_standard":{"type":"string","maxLength":6,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to submit a CONCAT identifier. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]}},"required":["type","issuing_country"],"additionalProperties":false},"id":"schema_900"},"schema_901":{"kind":"json-schema","data":{"title":"Identifier","type":"object","properties":{"id":{"title":"Unique identifier for the user's national ID.","type":"string","description":"Unique identifier for the user's national ID.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"identifier_standard":{"type":"string","maxLength":6,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to submit a CONCAT identifier. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]},"identifier":{"type":"string","maxLength":30,"minLength":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier value. Omit this field when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the value is generated by Upvest from the user's name and date of birth. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NATIONAL_ID -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["NATIONAL_ID","PASSPORT"],"default":"NATIONAL_ID"},"issuing_country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["id","user_id","created_at","updated_at","identifier_standard","identifier","type","issuing_country"],"additionalProperties":false},"id":"schema_901"},"schema_902":{"kind":"json-schema","data":{"title":"Unique identifier for the user's national ID.","type":"string","description":"Unique identifier for the user's national ID.","format":"uuid"},"id":"schema_902"},"schema_903":{"kind":"json-schema","data":{"title":"Identifier - Update - Request","type":"object","properties":{"identifier":{"type":"string","maxLength":30,"minLength":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier value. Omit this field when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONCAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the value is generated by Upvest from the user's name and date of birth. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/users/identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide here"},"children":[]}]}]}]}]}},"required":["identifier"],"additionalProperties":false},"id":"schema_903"},"schema_904":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_904"},"schema_905":{"kind":"json-schema","data":{"type":"string","enum":["KYC","INSTRUMENT_FIT","POR","COMPLIANCE","GUARDIAN","USER_SELF_ASSESSMENT","US_WITHHOLDING_TAX_STATUS"]},"id":"schema_905"},"schema_906":{"kind":"json-schema","data":{"title":"User Check - List - Response","type":"object","description":"","properties":{"data":{"type":"array","items":{"title":"User Check","oneOf":[{"title":"User Check - Know your customer","type":"object","description":"The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"KYC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYC”."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the KYC check. Must not be older than 24 months."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the KYC evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the KYC process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT - Residence Permit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE - Driving License"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD","RESIDENCE_PERMIT","DRIVING_LICENSE","TWO_PLUS_TWO_VERIFICATION_PROOF"]},"document_expiration_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the document used in KYC process in YYYY-MM-DD format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"nationality":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuing country of the document used in the KYC process. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the KYC check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - KYC check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - KYC check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - KYC check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"provider":{"type":"string","maxLength":100,"description":"Provider that was used to perform the KYC check."},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method used for AML-compliant KYC process"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIDEO_ID - Video identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PERSON_ID - In-person identification at the post office or the client's outlet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_COLLECTION - The identification document of the user is collected but has not undergone verification"},"children":[]}]}]}]}],"enum":["VIDEO_ID","IN_PERSON_ID","ELECTRONIC_ID","LIVENESS_PHOTO_ID","QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX","TWO_PLUS_TWO_VERIFICATION","ID_COLLECTION"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"kyc_update":{"type":"boolean","description":"Marks this check as a KYC refresh/update as opposed to an initial record."}},"required":["id","user_id","type","check_confirmed_at","data_download_link","document_type","status","provider","method"],"additionalProperties":false},{"title":"User Check - Proof of Residency","type":"object","description":"The PoR (Proof of residency) check is completed by the client sharing a valid PoR document, if not fulfilled by the KYC check.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"POR","description":"The type of check must be POR."},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"issuance_date":{"type":"string","format":"date","description":"Issuance date in YYYY-MM-DD format."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the PoR evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the PoR process. Maximum age of the document is 12 months (stated on the document) applicable for: Utility bills (water, gas, electricity), Telephone bills (only landline), Internet bills, Bank account statements. Documents that need to be still valid - Registration certificate (must be valid and issued within the past 5 years), Residence permit e.g. Blue Card (as long as valid and contains the registration address), ID Card that contains the registration address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TELEPHONE_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNET_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_STATEMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGISTRATION_CERT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["UTILITY_BILL","TELEPHONE_BILL","INTERNET_BILL","BANK_STATEMENT","REGISTRATION_CERT","RESIDENCE_PERMIT","ID_CARD","PASSPORT"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the PoR check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED -"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}},"required":["id","user_id","type","check_confirmed_at","issuance_date","data_download_link","document_type","status","confirmed_address"],"additionalProperties":false},{"title":"User Check - Instrument fit","type":"object","description":"Instrument fit check is completed by the client providing the user's answers to the instrument appropriateness or suitability questionnaire.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"INSTRUMENT_FIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be INSTRUMENT_FIT."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the instrument fit check."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the instrument fit check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Instrument fit check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Instrument fit check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Instrument fit check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"instrument_suitability":{"type":"object","properties":{"suitability":{"type":"boolean","description":"Did the user go through a suitability assessment and the outcome indicated suitability."}},"required":["suitability"]}},"required":["id","user_id","type","check_confirmed_at","status","instrument_suitability"],"additionalProperties":false},{"title":"User Check - Compliance","type":"object","description":"Compliance check","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"COMPLIANCE","description":"The type of check must be COMPLIANCE."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the COMPLIANCE check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Compliance check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Compliance check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Compliance check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the COMPLIANCE check."}},"required":["id","user_id","type","check_confirmed_at"],"additionalProperties":false},{"title":"User Check - Guardian","type":"object","description":"The Guardian check is completed by the client providing documentation proving the guardian relationship with the child user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"GUARDIAN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “GUARDIAN“."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"role_id":{"type":"string","format":"uuid","description":"Unique identifier for the role that this guardian check is associated with."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIRTH_CERTIFICATE - Birth certificate proving guardian relationship"},"children":[]}]}]}]}],"enum":["BIRTH_CERTIFICATE"]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the guardian evidence file. The file size must not exceed 250 MB."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Guardian check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Guardian check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Guardian check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]}},"required":["id","user_id","type","role_id","document_type","data_download_link","status"],"additionalProperties":false}]}}},"required":["data"],"additionalProperties":false},"id":"schema_906"},"schema_907":{"kind":"json-schema","data":{"title":"User Check - Create - Request","oneOf":[{"title":"User Check - Know your customer - Create - Request","type":"object","description":"The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.","properties":{"type":{"type":"string","default":"KYC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYC”."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the KYC check. Must not be older than 24 months."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the KYC evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the KYC process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT - Residence Permit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE - Driving License"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD","RESIDENCE_PERMIT","DRIVING_LICENSE","TWO_PLUS_TWO_VERIFICATION_PROOF"]},"document_expiration_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the document used in KYC process in YYYY-MM-DD format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"nationality":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuing country of the document used in the KYC process. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"provider":{"type":"string","maxLength":100,"description":"Provider that was used to perform the KYC check."},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method used for AML-compliant KYC process"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIDEO_ID - Video identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PERSON_ID - In-person identification at the post office or the client's outlet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_COLLECTION - The identification document of the user is collected but has not undergone verification"},"children":[]}]}]}]}],"enum":["VIDEO_ID","IN_PERSON_ID","ELECTRONIC_ID","LIVENESS_PHOTO_ID","QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX","TWO_PLUS_TWO_VERIFICATION","ID_COLLECTION"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"kyc_update":{"type":"boolean","description":"Marks this check as a KYC refresh/update as opposed to an initial record."}},"required":["type","check_confirmed_at","data_download_link","document_type","provider","method"],"additionalProperties":false},{"title":"User Check - Proof of Residency - Create - Request","type":"object","description":"The PoR (Proof of residency) check is completed by the client sharing a valid PoR document, if not fulfilled by the KYC check.","properties":{"type":{"type":"string","default":"POR","description":"The type of check must be POR."},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"issuance_date":{"type":"string","format":"date","description":"Issuance date in YYYY-MM-DD format."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the PoR evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the PoR process. Maximum age of the document is 12 months (stated on the document) applicable for: Utility bills (water, gas, electricity), Telephone bills (only landline), Internet bills, Bank account statements. Documents that need to be still valid - Registration certificate (must be valid and issued within the past 5 years), Residence permit e.g. Blue Card (as long as valid and contains the registration address), ID Card that contains the registration address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TELEPHONE_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNET_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_STATEMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGISTRATION_CERT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD -"},"children":[]}]}]}]}],"enum":["UTILITY_BILL","TELEPHONE_BILL","INTERNET_BILL","BANK_STATEMENT","REGISTRATION_CERT","RESIDENCE_PERMIT","ID_CARD"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}},"required":["type","check_confirmed_at","issuance_date","data_download_link","document_type","confirmed_address"],"additionalProperties":false},{"title":"User Check - Instrument fit - Create - Request","type":"object","description":"Instrument fit check is completed by the client providing the user's answers to the instrument appropriateness or suitability questionnaire.","properties":{"type":{"type":"string","default":"INSTRUMENT_FIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be INSTRUMENT_FIT."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the instrument fit check."},"instrument_suitability":{"type":"object","properties":{"suitability":{"type":"boolean","description":"Did the user go through a suitability assessment and the outcome indicated suitability."}},"required":["suitability"]}},"required":["type","check_confirmed_at","instrument_suitability"],"additionalProperties":false},{"title":"User Check - Guardian - Create - Request","type":"object","description":"The Guardian check is completed by the client providing documentation proving the guardian relationship with the child user.","properties":{"type":{"type":"string","default":"GUARDIAN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “GUARDIAN“."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"role_id":{"type":"string","format":"uuid","description":"Unique identifier for the role that this guardian check is associated with."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIRTH_CERTIFICATE - Birth certificate proving guardian relationship"},"children":[]}]}]}]}],"enum":["BIRTH_CERTIFICATE"]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the guardian evidence file. The file size must not exceed 250 MB."}},"required":["type","check_confirmed_at","role_id","document_type","data_download_link"],"additionalProperties":false}]},"id":"schema_907"},"schema_908":{"kind":"json-schema","data":{"title":"User Check - Create - Response","type":"object","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"}},"required":["id"],"additionalProperties":false},"id":"schema_908"},"schema_909":{"kind":"json-schema","data":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"id":"schema_909"},"schema_910":{"kind":"json-schema","data":{"title":"User Check","oneOf":[{"title":"User Check - Know your customer","type":"object","description":"The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"KYC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYC”."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the KYC check. Must not be older than 24 months."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the KYC evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the KYC process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT - Residence Permit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE - Driving License"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD","RESIDENCE_PERMIT","DRIVING_LICENSE","TWO_PLUS_TWO_VERIFICATION_PROOF"]},"document_expiration_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the document used in KYC process in YYYY-MM-DD format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"nationality":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuing country of the document used in the KYC process. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the KYC check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - KYC check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - KYC check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - KYC check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"provider":{"type":"string","maxLength":100,"description":"Provider that was used to perform the KYC check."},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method used for AML-compliant KYC process"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIDEO_ID - Video identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PERSON_ID - In-person identification at the post office or the client's outlet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_COLLECTION - The identification document of the user is collected but has not undergone verification"},"children":[]}]}]}]}],"enum":["VIDEO_ID","IN_PERSON_ID","ELECTRONIC_ID","LIVENESS_PHOTO_ID","QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX","TWO_PLUS_TWO_VERIFICATION","ID_COLLECTION"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"kyc_update":{"type":"boolean","description":"Marks this check as a KYC refresh/update as opposed to an initial record."}},"required":["id","user_id","type","check_confirmed_at","data_download_link","document_type","status","provider","method"],"additionalProperties":false},{"title":"User Check - Proof of Residency","type":"object","description":"The PoR (Proof of residency) check is completed by the client sharing a valid PoR document, if not fulfilled by the KYC check.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"POR","description":"The type of check must be POR."},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"issuance_date":{"type":"string","format":"date","description":"Issuance date in YYYY-MM-DD format."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the PoR evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the PoR process. Maximum age of the document is 12 months (stated on the document) applicable for: Utility bills (water, gas, electricity), Telephone bills (only landline), Internet bills, Bank account statements. Documents that need to be still valid - Registration certificate (must be valid and issued within the past 5 years), Residence permit e.g. Blue Card (as long as valid and contains the registration address), ID Card that contains the registration address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TELEPHONE_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNET_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_STATEMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGISTRATION_CERT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["UTILITY_BILL","TELEPHONE_BILL","INTERNET_BILL","BANK_STATEMENT","REGISTRATION_CERT","RESIDENCE_PERMIT","ID_CARD","PASSPORT"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the PoR check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED -"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}},"required":["id","user_id","type","check_confirmed_at","issuance_date","data_download_link","document_type","status","confirmed_address"],"additionalProperties":false},{"title":"User Check - Instrument fit","type":"object","description":"Instrument fit check is completed by the client providing the user's answers to the instrument appropriateness or suitability questionnaire.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"INSTRUMENT_FIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be INSTRUMENT_FIT."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the instrument fit check."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the instrument fit check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Instrument fit check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Instrument fit check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Instrument fit check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"instrument_suitability":{"type":"object","properties":{"suitability":{"type":"boolean","description":"Did the user go through a suitability assessment and the outcome indicated suitability."}},"required":["suitability"]}},"required":["id","user_id","type","check_confirmed_at","status","instrument_suitability"],"additionalProperties":false},{"title":"User Check - Compliance","type":"object","description":"Compliance check","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"COMPLIANCE","description":"The type of check must be COMPLIANCE."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the COMPLIANCE check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Compliance check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Compliance check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Compliance check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the COMPLIANCE check."}},"required":["id","user_id","type","check_confirmed_at"],"additionalProperties":false},{"title":"User Check - Guardian","type":"object","description":"The Guardian check is completed by the client providing documentation proving the guardian relationship with the child user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"GUARDIAN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “GUARDIAN“."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"role_id":{"type":"string","format":"uuid","description":"Unique identifier for the role that this guardian check is associated with."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIRTH_CERTIFICATE - Birth certificate proving guardian relationship"},"children":[]}]}]}]}],"enum":["BIRTH_CERTIFICATE"]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the guardian evidence file. The file size must not exceed 250 MB."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Guardian check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Guardian check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Guardian check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]}},"required":["id","user_id","type","role_id","document_type","data_download_link","status"],"additionalProperties":false}]},"id":"schema_910"},"schema_911":{"kind":"json-schema","data":{"title":"Webhook - User Checks - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["USER_CHECK.CREATED","USER_CHECK.PASSED","USER_CHECK.FAILED"]},"object":{"title":"User Check","oneOf":[{"title":"User Check - Know your customer","type":"object","description":"The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"KYC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYC”."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the KYC check. Must not be older than 24 months."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the KYC evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the KYC process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT - Passport"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD - National Identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT - Residence Permit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE - Driving License"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)"},"children":[]}]}]}]}],"enum":["PASSPORT","ID_CARD","RESIDENCE_PERMIT","DRIVING_LICENSE","TWO_PLUS_TWO_VERIFICATION_PROOF"]},"document_expiration_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the document used in KYC process in YYYY-MM-DD format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"nationality":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuing country of the document used in the KYC process. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required for the following document types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the KYC check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - KYC check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - KYC check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - KYC check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"provider":{"type":"string","maxLength":100,"description":"Provider that was used to perform the KYC check."},"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method used for AML-compliant KYC process"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIDEO_ID - Video identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PERSON_ID - In-person identification at the post office or the client's outlet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_COLLECTION - The identification document of the user is collected but has not undergone verification"},"children":[]}]}]}]}],"enum":["VIDEO_ID","IN_PERSON_ID","ELECTRONIC_ID","LIVENESS_PHOTO_ID","QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX","TWO_PLUS_TWO_VERIFICATION","ID_COLLECTION"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"kyc_update":{"type":"boolean","description":"Marks this check as a KYC refresh/update as opposed to an initial record."}},"required":["id","user_id","type","check_confirmed_at","data_download_link","document_type","status","provider","method"],"additionalProperties":false},{"title":"User Check - Proof of Residency","type":"object","description":"The PoR (Proof of residency) check is completed by the client sharing a valid PoR document, if not fulfilled by the KYC check.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"POR","description":"The type of check must be POR."},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"issuance_date":{"type":"string","format":"date","description":"Issuance date in YYYY-MM-DD format."},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the PoR evidence file. The file size must not exceed 250 MB."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the PoR process. Maximum age of the document is 12 months (stated on the document) applicable for: Utility bills (water, gas, electricity), Telephone bills (only landline), Internet bills, Bank account statements. Documents that need to be still valid - Registration certificate (must be valid and issued within the past 5 years), Residence permit e.g. Blue Card (as long as valid and contains the registration address), ID Card that contains the registration address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TELEPHONE_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNET_BILL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_STATEMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGISTRATION_CERT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESIDENCE_PERMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_CARD -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSPORT -"},"children":[]}]}]}]}],"enum":["UTILITY_BILL","TELEPHONE_BILL","INTERNET_BILL","BANK_STATEMENT","REGISTRATION_CERT","RESIDENCE_PERMIT","ID_CARD","PASSPORT"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the PoR check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED -"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"confirmed_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}},"required":["id","user_id","type","check_confirmed_at","issuance_date","data_download_link","document_type","status","confirmed_address"],"additionalProperties":false},{"title":"User Check - Instrument fit","type":"object","description":"Instrument fit check is completed by the client providing the user's answers to the instrument appropriateness or suitability questionnaire.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"INSTRUMENT_FIT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be INSTRUMENT_FIT."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the instrument fit check."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the instrument fit check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Instrument fit check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Instrument fit check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Instrument fit check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"instrument_suitability":{"type":"object","properties":{"suitability":{"type":"boolean","description":"Did the user go through a suitability assessment and the outcome indicated suitability."}},"required":["suitability"]}},"required":["id","user_id","type","check_confirmed_at","status","instrument_suitability"],"additionalProperties":false},{"title":"User Check - Compliance","type":"object","description":"Compliance check","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"COMPLIANCE","description":"The type of check must be COMPLIANCE."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the COMPLIANCE check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Compliance check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Compliance check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Compliance check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the COMPLIANCE check."}},"required":["id","user_id","type","check_confirmed_at"],"additionalProperties":false},{"title":"User Check - Guardian","type":"object","description":"The Guardian check is completed by the client providing documentation proving the guardian relationship with the child user.","properties":{"id":{"title":"User Check unique identifier","type":"string","description":"User Check unique identifier.","format":"uuid"},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","default":"GUARDIAN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “GUARDIAN“."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"Completion date and time of the PoR check."},"role_id":{"type":"string","format":"uuid","description":"Unique identifier for the role that this guardian check is associated with."},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of document used in the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIRTH_CERTIFICATE - Birth certificate proving guardian relationship"},"children":[]}]}]}]}],"enum":["BIRTH_CERTIFICATE"]},"data_download_link":{"type":"string","format":"url","maxLength":1000,"description":"Download URL for the guardian evidence file. The file size must not exceed 250 MB."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the Guardian check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Guardian check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Guardian check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Guardian check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]}},"required":["id","user_id","type","role_id","document_type","data_download_link","status"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_911"},"schema_912":{"kind":"json-schema","data":{"title":"Businesses - List - Response","type":"object","description":"Response for listing businesses.","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Business","oneOf":[{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"default":"LIMITED_LIABILITY_COMPANY","description":"Type of the business."},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"district_court":{"type":"string","minLength":1,"maxLength":40,"description":"District court where the company is registered."},"legal_designation":{"type":"string","enum":["GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","UNTERNEHMERGESELLSCHAFT","AKTIENGESELLSCHAFT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country specific legal designation of the company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AKTIENGESELLSCHAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businesses cannot be created via the API; please contact Upvest support before onboarding such a business."},"children":[]}]}]}]},"legal_entity_identifier":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Legal_Entity_Identifier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 17442"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"common_reporting_standards":{"type":"object","properties":{"is_passive_non_financial_entity":{"type":"boolean","description":"Indicates if the company is a passive non-financial entity."},"is_financial_institution":{"type":"boolean","description":"Indicates if the company is a financial institution."}},"required":["is_passive_non_financial_entity","is_financial_institution"],"description":"Common reporting standards information."}},"required":["company_name","incorporation_date","district_court","legal_designation","common_reporting_standards"],"description":"Identification information of the business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","contact_email","registered_address","registration_number","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status","created_at","updated_at"],"additionalProperties":false},{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"type":"string","default":"SOLE_TRADER"},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the sole trader business."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"legal_designation":{"type":"string","enum":["EINZELUNTERNEHMER","FREIBERUFLER","EINGETRAGENER_KAUFMANN","EINGETRAGENE_KAUFFRAU"],"description":"Country specific legal designation of the sole trader business."}},"required":["company_name","legal_designation"],"description":"Identification information of the sole trader business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","created_at","updated_at","contact_email","registered_address","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status"],"additionalProperties":false}]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_912"},"schema_913":{"kind":"json-schema","data":{"title":"Business - Create - Request","oneOf":[{"type":"object","title":"Business (Company) - Create - Request","description":"Schema for business company information.","properties":{"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"default":"LIMITED_LIABILITY_COMPANY","description":"Type of the business."},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"district_court":{"type":"string","minLength":1,"maxLength":40,"description":"District court where the company is registered."},"legal_designation":{"type":"string","enum":["GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","UNTERNEHMERGESELLSCHAFT","AKTIENGESELLSCHAFT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country specific legal designation of the company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AKTIENGESELLSCHAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businesses cannot be created via the API; please contact Upvest support before onboarding such a business."},"children":[]}]}]}]},"legal_entity_identifier":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Legal_Entity_Identifier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 17442"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"common_reporting_standards":{"type":"object","properties":{"is_passive_non_financial_entity":{"type":"boolean","description":"Indicates if the company is a passive non-financial entity."},"is_financial_institution":{"type":"boolean","description":"Indicates if the company is a financial institution."}},"required":["is_passive_non_financial_entity","is_financial_institution"],"description":"Common reporting standards information."}},"required":["company_name","incorporation_date","district_court","legal_designation","common_reporting_standards"],"description":"Identification information of the business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."}},"required":["contact_email","registered_address","registration_number","business_type","tax_information","identification","terms_and_conditions","data_privacy_and_sharing_agreement"]},{"type":"object","title":"Business (Sole Trader) - Create - Request","description":"Schema for business company information.","properties":{"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"type":"string","default":"SOLE_TRADER"},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the sole trader business."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"legal_designation":{"type":"string","enum":["EINZELUNTERNEHMER","FREIBERUFLER","EINGETRAGENER_KAUFMANN","EINGETRAGENE_KAUFFRAU"],"description":"Country specific legal designation of the sole trader business."}},"required":["company_name","legal_designation"],"description":"Identification information of the sole trader business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."}},"required":["contact_email","registered_address","business_type","identification","tax_information","terms_and_conditions","data_privacy_and_sharing_agreement"]}]},"id":"schema_913"},"schema_914":{"kind":"json-schema","data":{"title":"Business - Create - Request","oneOf":[{"type":"object","title":"Business (Company) - Create - Response","description":"Response schema for the create business endpoint.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"default":"LIMITED_LIABILITY_COMPANY","description":"Type of the business."},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"district_court":{"type":"string","minLength":1,"maxLength":40,"description":"District court where the company is registered."},"legal_designation":{"type":"string","enum":["GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","UNTERNEHMERGESELLSCHAFT","AKTIENGESELLSCHAFT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country specific legal designation of the company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AKTIENGESELLSCHAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businesses cannot be created via the API; please contact Upvest support before onboarding such a business."},"children":[]}]}]}]},"legal_entity_identifier":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Legal_Entity_Identifier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 17442"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"common_reporting_standards":{"type":"object","properties":{"is_passive_non_financial_entity":{"type":"boolean","description":"Indicates if the company is a passive non-financial entity."},"is_financial_institution":{"type":"boolean","description":"Indicates if the company is a financial institution."}},"required":["is_passive_non_financial_entity","is_financial_institution"],"description":"Common reporting standards information."}},"required":["company_name","incorporation_date","district_court","legal_designation","common_reporting_standards"],"description":"Identification information of the business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}}},{"type":"object","title":"Business (Sole Trader) - Create - Response","description":"Response schema for the create business endpoint.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"type":"string","default":"SOLE_TRADER"},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the sole trader business."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"legal_designation":{"type":"string","enum":["EINZELUNTERNEHMER","FREIBERUFLER","EINGETRAGENER_KAUFMANN","EINGETRAGENE_KAUFFRAU"],"description":"Country specific legal designation of the sole trader business."}},"required":["company_name","legal_designation"],"description":"Identification information of the sole trader business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}}}]},"id":"schema_914"},"schema_915":{"kind":"json-schema","data":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"id":"schema_915"},"schema_916":{"kind":"json-schema","data":{"oneOf":[{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"default":"LIMITED_LIABILITY_COMPANY","description":"Type of the business."},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"district_court":{"type":"string","minLength":1,"maxLength":40,"description":"District court where the company is registered."},"legal_designation":{"type":"string","enum":["GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","UNTERNEHMERGESELLSCHAFT","AKTIENGESELLSCHAFT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country specific legal designation of the company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AKTIENGESELLSCHAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businesses cannot be created via the API; please contact Upvest support before onboarding such a business."},"children":[]}]}]}]},"legal_entity_identifier":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Legal_Entity_Identifier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 17442"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"common_reporting_standards":{"type":"object","properties":{"is_passive_non_financial_entity":{"type":"boolean","description":"Indicates if the company is a passive non-financial entity."},"is_financial_institution":{"type":"boolean","description":"Indicates if the company is a financial institution."}},"required":["is_passive_non_financial_entity","is_financial_institution"],"description":"Common reporting standards information."}},"required":["company_name","incorporation_date","district_court","legal_designation","common_reporting_standards"],"description":"Identification information of the business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","contact_email","registered_address","registration_number","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status","created_at","updated_at"],"additionalProperties":false},{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"type":"string","default":"SOLE_TRADER"},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the sole trader business."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"legal_designation":{"type":"string","enum":["EINZELUNTERNEHMER","FREIBERUFLER","EINGETRAGENER_KAUFMANN","EINGETRAGENE_KAUFFRAU"],"description":"Country specific legal designation of the sole trader business."}},"required":["company_name","legal_designation"],"description":"Identification information of the sole trader business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","created_at","updated_at","contact_email","registered_address","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status"],"additionalProperties":false}]},"id":"schema_916"},"schema_917":{"kind":"json-schema","data":{"anyOf":[{"title":"Business (Company) - Update - Request","type":"object","properties":{"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."}}}]},"id":"schema_917"},"schema_918":{"kind":"json-schema","data":{"title":"Webhook - Businesses - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["BUSINESS.CREATED","BUSINESS.ACTIVATED","BUSINESS.DEACTIVATED","BUSINESS.DATA_CHANGED","BUSINESS.DATA_CHANGE_FAILED","BUSINESS.OFFBOARDING_INITIATED","BUSINESS.OFFBOARDED"]},"object":{"oneOf":[{"title":"Business Event","oneOf":[{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"default":"LIMITED_LIABILITY_COMPANY","description":"Type of the business."},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"district_court":{"type":"string","minLength":1,"maxLength":40,"description":"District court where the company is registered."},"legal_designation":{"type":"string","enum":["GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","UNTERNEHMERGESELLSCHAFT","AKTIENGESELLSCHAFT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country specific legal designation of the company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AKTIENGESELLSCHAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businesses cannot be created via the API; please contact Upvest support before onboarding such a business."},"children":[]}]}]}]},"legal_entity_identifier":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Legal_Entity_Identifier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 17442"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"common_reporting_standards":{"type":"object","properties":{"is_passive_non_financial_entity":{"type":"boolean","description":"Indicates if the company is a passive non-financial entity."},"is_financial_institution":{"type":"boolean","description":"Indicates if the company is a financial institution."}},"required":["is_passive_non_financial_entity","is_financial_institution"],"description":"Common reporting standards information."}},"required":["company_name","incorporation_date","district_court","legal_designation","common_reporting_standards"],"description":"Identification information of the business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","contact_email","registered_address","registration_number","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status","created_at","updated_at"],"additionalProperties":false},{"type":"object","description":"Schema for business company information.","properties":{"id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"contact_email":{"type":"string","format":"email","description":"Contact email address of the business."},"registered_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"registration_number":{"type":"string","description":"Registration number of the business."},"tax_information":{"type":"object","properties":{"tax_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identification_type":{"type":"string","enum":["STEUERNUMMER","WIRTSCHAFTSIDENTIFIKATIONSNUMMER"],"description":"Type of tax identification used by the business."},"tax_identification_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax identification number of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEUERNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bare digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 or 11 digits"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345678901"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North Rhine-Westphalia"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/4/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133/8150/8159"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bavaria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/08155"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard 10-digit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2/3/5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24/815/08151"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative 10-digit (Berlin, Bremen, Lower Saxony)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3/3/4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"181/815/0815"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_identification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRTSCHAFTSIDENTIFIKATIONSNUMMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by 9 digits, with an optional 5-digit distinguishing feature (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE123456789-00001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"is_resident_in_multiple_tax_jurisdictions":{"type":"boolean","description":"Indicates if the business is resident in multiple tax jurisdictions."},"is_subject_to_fatca":{"type":"boolean","description":"Indicates if the business is subject to FATCA regulations."}},"required":["tax_country_code","tax_identification_type","tax_identification_number","is_resident_in_multiple_tax_jurisdictions","is_subject_to_fatca"],"description":"Tax information of the business."},"business_type":{"type":"string","default":"SOLE_TRADER"},"identification":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the sole trader business."},"incorporation_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation date of the business in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"legal_designation":{"type":"string","enum":["EINZELUNTERNEHMER","FREIBERUFLER","EINGETRAGENER_KAUFMANN","EINGETRAGENE_KAUFFRAU"],"description":"Country specific legal designation of the sole trader business."}},"required":["company_name","legal_designation"],"description":"Identification information of the sole trader business."},"terms_and_conditions":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the consent document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the terms and conditions were confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Terms and conditions agreement."},"data_privacy_and_sharing_agreement":{"type":"object","properties":{"consent_document_id":{"type":"string","format":"uuid","description":"UUID of the data privacy and sharing agreement document."},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp when the data privacy and sharing agreement was confirmed."}},"required":["consent_document_id","confirmed_at"],"description":"Data privacy and sharing agreement."},"status":{"enum":["ACTIVE","INACTIVE","OFFBOARDING","OFFBOARDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the business."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OFFBOARDED -"},"children":[]}]}]}]}]}},"required":["id","created_at","updated_at","contact_email","registered_address","tax_information","business_type","identification","terms_and_conditions","data_privacy_and_sharing_agreement","status"],"additionalProperties":false}]},{"title":"Businesses Update Failed Event","type":"object","properties":{"business_id":{"type":"string","format":"uuid","description":"Event unique identifier"},"reason":{"type":"string","maxLength":100,"description":"The reason why the data change failed."}},"required":["business_id","reason"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_918"},"schema_919":{"kind":"json-schema","data":{"title":"Business Check - List - Response","type":"object","description":"List of business checks.","properties":{"data":{"type":"array","items":{"title":"Business Check","oneOf":[{"title":"Business Check - KYB","type":"object","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"KYB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYB”."},"children":[]}]}]}]},"originally_confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the check was first confirmed. When the check has only been confirmed once, this value is the same as check_confirmed_at. When renewing KYB check, this value remains the same as when the check was first confirmed."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the check was latest confirmed"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"data_download_link":{"type":"string","format":"uri"},"document_type":{"type":"string","default":"KYB_DOCUMENTS"}},"required":["id","business_id","type","originally_confirmed_at","check_confirmed_at","status","data_download_link","document_type"]},{"title":"Business Check - Business Self Assessment","type":"object","description":"The Business Self Assessment check captures information about the business's activities, financials, and purpose of the business relationship for risk scoring.","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"BUSINESS_SELF_ASSESSMENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be \"BUSINESS_SELF_ASSESSMENT\"."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the self assessment check was confirmed."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"business_industry":{"title":"Business Industry","type":"string","description":"The business industry classification.","enum":["ACCOMMODATION_AND_HOSPITALITY","ACCOMMODATION_AND_HOSPITALITY_TIMESHARING","ADMIN_AND_SUPPORT_SERVICES","ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES","ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION","ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS","AGRICULTURE_FORESTRY_AND_FISHING","CONSTRUCTION","EDUCATION","EDUCATION_HIGHER_EDUCATION","ENTERTAINMENT_ARTS_AND_RECREATION","ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS","ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS","EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES","FINANCIAL_SERVICES","FOOD_AND_BEVERAGE_SERVICES","HEALTHCARE","HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES","INFORMATION_TECHNOLOGY_AND_MEDIA","INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING","INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING","INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS","MANUFACTURING","MANUFACTURING_PHARMACEUTICALS","MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY","MANUFACTURING_WEAPONS_AND_HAZARDOUS","MINING_AND_QUARRYING","PERSONAL_AND_OTHER_SERVICES","PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS","PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS","PROFESSIONAL_AND_TECHNICAL_SERVICES","PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY","PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED","PUBLIC_ADMINISTRATION","PUBLIC_ADMINISTRATION_JUDICIAL","REAL_ESTATE","REAL_ESTATE_AGENCY_AND_BROKERAGE","RETAIL_TRADE","RETAIL_TRADE_SPECIALITY","RETAIL_TRADE_SPECIFIC_SECTORS","TRANSPORTATION_AND_LOGISTICS","TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES","TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE","UTILITIES_AND_ENERGY","WHOLESALE_TRADE","WHOLESALE_TRADE_INDUSTRIAL","WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES","WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS"]},"purpose_of_business_relationship":{"title":"Purpose of Business Relationship","type":"string","description":"The purpose of the business relationship.","enum":["WEALTH_GROWTH","TREASURY_LIQUIDITY_MANAGEMENT","HEDGING_RISK_MANAGEMENT","EMPLOYEE_BENEFIT_FUNDING","STRATEGIC_INVESTMENT"]},"primary_countries_of_activity":{"type":"array","description":"List of primary countries where the business operates. ISO 3166-1 alpha-2 country codes.","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1},"annual_revenue":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"expected_volume_of_investment":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"total_asset_value":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false}},"required":["id","business_id","type","check_confirmed_at","status","business_industry","purpose_of_business_relationship","primary_countries_of_activity","annual_revenue","expected_volume_of_investment","total_asset_value"],"additionalProperties":false}]}}},"required":["data"],"additionalProperties":false},"id":"schema_919"},"schema_920":{"kind":"json-schema","data":{"title":"Business Check - Create - Request","oneOf":[{"title":"Business Check - Know Your Business - Create - Request","type":"object","description":"The KYB (Know Your Business) check is completed by the client sharing the valid and relevant KYB data for the business.","properties":{"type":{"type":"string","default":"KYB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYB”."},"children":[]}]}]}]},"originally_confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the check was first confirmed. When the check has only been confirmed once, this value is the same as check_confirmed_at. When renewing KYB check, this value remains the same as when the check was first confirmed."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the check was latest confirmed"},"data_download_link":{"type":"string","format":"uri"}},"required":["type","originally_confirmed_at","check_confirmed_at","data_download_link"],"additionalProperties":false},{"title":"Business Check - Business Self Assessment - Create - Request","type":"object","description":"The Business Self Assessment check is completed by the client providing self-assessment information about the business for risk scoring purposes.","properties":{"type":{"type":"string","default":"BUSINESS_SELF_ASSESSMENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be \"BUSINESS_SELF_ASSESSMENT\"."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the self assessment check was confirmed."},"business_industry":{"title":"Business Industry","type":"string","description":"The business industry classification.","enum":["ACCOMMODATION_AND_HOSPITALITY","ACCOMMODATION_AND_HOSPITALITY_TIMESHARING","ADMIN_AND_SUPPORT_SERVICES","ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES","ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION","ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS","AGRICULTURE_FORESTRY_AND_FISHING","CONSTRUCTION","EDUCATION","EDUCATION_HIGHER_EDUCATION","ENTERTAINMENT_ARTS_AND_RECREATION","ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS","ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS","EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES","FINANCIAL_SERVICES","FOOD_AND_BEVERAGE_SERVICES","HEALTHCARE","HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES","INFORMATION_TECHNOLOGY_AND_MEDIA","INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING","INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING","INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS","MANUFACTURING","MANUFACTURING_PHARMACEUTICALS","MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY","MANUFACTURING_WEAPONS_AND_HAZARDOUS","MINING_AND_QUARRYING","PERSONAL_AND_OTHER_SERVICES","PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS","PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS","PROFESSIONAL_AND_TECHNICAL_SERVICES","PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY","PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED","PUBLIC_ADMINISTRATION","PUBLIC_ADMINISTRATION_JUDICIAL","REAL_ESTATE","REAL_ESTATE_AGENCY_AND_BROKERAGE","RETAIL_TRADE","RETAIL_TRADE_SPECIALITY","RETAIL_TRADE_SPECIFIC_SECTORS","TRANSPORTATION_AND_LOGISTICS","TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES","TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE","UTILITIES_AND_ENERGY","WHOLESALE_TRADE","WHOLESALE_TRADE_INDUSTRIAL","WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES","WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS"]},"purpose_of_business_relationship":{"title":"Purpose of Business Relationship","type":"string","description":"The purpose of the business relationship.","enum":["WEALTH_GROWTH","TREASURY_LIQUIDITY_MANAGEMENT","HEDGING_RISK_MANAGEMENT","EMPLOYEE_BENEFIT_FUNDING","STRATEGIC_INVESTMENT"]},"primary_countries_of_activity":{"type":"array","description":"List of primary countries where the business operates. ISO 3166-1 alpha-2 country codes.","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1},"annual_revenue":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"expected_volume_of_investment":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"total_asset_value":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false}},"required":["type","check_confirmed_at","business_industry","purpose_of_business_relationship","primary_countries_of_activity","annual_revenue","expected_volume_of_investment","total_asset_value"],"additionalProperties":false}]},"id":"schema_920"},"schema_921":{"kind":"json-schema","data":{"title":"Business Check - Create - Response","type":"object","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"}},"required":["id"],"additionalProperties":false},"id":"schema_921"},"schema_922":{"kind":"json-schema","data":{"title":"Business Check","oneOf":[{"title":"Business Check - KYB","type":"object","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"KYB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYB”."},"children":[]}]}]}]},"originally_confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the check was first confirmed. When the check has only been confirmed once, this value is the same as check_confirmed_at. When renewing KYB check, this value remains the same as when the check was first confirmed."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the check was latest confirmed"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"data_download_link":{"type":"string","format":"uri"},"document_type":{"type":"string","default":"KYB_DOCUMENTS"}},"required":["id","business_id","type","originally_confirmed_at","check_confirmed_at","status","data_download_link","document_type"]},{"title":"Business Check - Business Self Assessment","type":"object","description":"The Business Self Assessment check captures information about the business's activities, financials, and purpose of the business relationship for risk scoring.","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"BUSINESS_SELF_ASSESSMENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be \"BUSINESS_SELF_ASSESSMENT\"."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the self assessment check was confirmed."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"business_industry":{"title":"Business Industry","type":"string","description":"The business industry classification.","enum":["ACCOMMODATION_AND_HOSPITALITY","ACCOMMODATION_AND_HOSPITALITY_TIMESHARING","ADMIN_AND_SUPPORT_SERVICES","ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES","ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION","ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS","AGRICULTURE_FORESTRY_AND_FISHING","CONSTRUCTION","EDUCATION","EDUCATION_HIGHER_EDUCATION","ENTERTAINMENT_ARTS_AND_RECREATION","ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS","ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS","EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES","FINANCIAL_SERVICES","FOOD_AND_BEVERAGE_SERVICES","HEALTHCARE","HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES","INFORMATION_TECHNOLOGY_AND_MEDIA","INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING","INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING","INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS","MANUFACTURING","MANUFACTURING_PHARMACEUTICALS","MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY","MANUFACTURING_WEAPONS_AND_HAZARDOUS","MINING_AND_QUARRYING","PERSONAL_AND_OTHER_SERVICES","PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS","PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS","PROFESSIONAL_AND_TECHNICAL_SERVICES","PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY","PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED","PUBLIC_ADMINISTRATION","PUBLIC_ADMINISTRATION_JUDICIAL","REAL_ESTATE","REAL_ESTATE_AGENCY_AND_BROKERAGE","RETAIL_TRADE","RETAIL_TRADE_SPECIALITY","RETAIL_TRADE_SPECIFIC_SECTORS","TRANSPORTATION_AND_LOGISTICS","TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES","TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE","UTILITIES_AND_ENERGY","WHOLESALE_TRADE","WHOLESALE_TRADE_INDUSTRIAL","WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES","WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS"]},"purpose_of_business_relationship":{"title":"Purpose of Business Relationship","type":"string","description":"The purpose of the business relationship.","enum":["WEALTH_GROWTH","TREASURY_LIQUIDITY_MANAGEMENT","HEDGING_RISK_MANAGEMENT","EMPLOYEE_BENEFIT_FUNDING","STRATEGIC_INVESTMENT"]},"primary_countries_of_activity":{"type":"array","description":"List of primary countries where the business operates. ISO 3166-1 alpha-2 country codes.","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1},"annual_revenue":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"expected_volume_of_investment":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"total_asset_value":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false}},"required":["id","business_id","type","check_confirmed_at","status","business_industry","purpose_of_business_relationship","primary_countries_of_activity","annual_revenue","expected_volume_of_investment","total_asset_value"],"additionalProperties":false}]},"id":"schema_922"},"schema_923":{"kind":"json-schema","data":{"title":"Webhook - Business Checks - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["BUSINESS_CHECK.CREATED","BUSINESS_CHECK.PASSED","BUSINESS_CHECK.FAILED"]},"object":{"title":"Business Check","oneOf":[{"title":"Business Check - KYB","type":"object","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"KYB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be “KYB”."},"children":[]}]}]}]},"originally_confirmed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the check was first confirmed. When the check has only been confirmed once, this value is the same as check_confirmed_at. When renewing KYB check, this value remains the same as when the check was first confirmed."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the check was latest confirmed"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"data_download_link":{"type":"string","format":"uri"},"document_type":{"type":"string","default":"KYB_DOCUMENTS"}},"required":["id","business_id","type","originally_confirmed_at","check_confirmed_at","status","data_download_link","document_type"]},{"title":"Business Check - Business Self Assessment","type":"object","description":"The Business Self Assessment check captures information about the business's activities, financials, and purpose of the business relationship for risk scoring.","properties":{"id":{"title":"Business Check unique identifier","type":"string","description":"Business Check unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","default":"BUSINESS_SELF_ASSESSMENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of check must be \"BUSINESS_SELF_ASSESSMENT\"."},"children":[]}]}]}]},"check_confirmed_at":{"type":"string","format":"date-time","description":"The date and time when the self assessment check was confirmed."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status of the business check."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN_PROGRESS - Check is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PASSED - Check passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Check failed"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","PASSED","FAILED"]},"business_industry":{"title":"Business Industry","type":"string","description":"The business industry classification.","enum":["ACCOMMODATION_AND_HOSPITALITY","ACCOMMODATION_AND_HOSPITALITY_TIMESHARING","ADMIN_AND_SUPPORT_SERVICES","ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES","ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION","ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS","AGRICULTURE_FORESTRY_AND_FISHING","CONSTRUCTION","EDUCATION","EDUCATION_HIGHER_EDUCATION","ENTERTAINMENT_ARTS_AND_RECREATION","ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS","ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS","EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES","FINANCIAL_SERVICES","FOOD_AND_BEVERAGE_SERVICES","HEALTHCARE","HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES","INFORMATION_TECHNOLOGY_AND_MEDIA","INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING","INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING","INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS","MANUFACTURING","MANUFACTURING_PHARMACEUTICALS","MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY","MANUFACTURING_WEAPONS_AND_HAZARDOUS","MINING_AND_QUARRYING","PERSONAL_AND_OTHER_SERVICES","PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS","PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS","PROFESSIONAL_AND_TECHNICAL_SERVICES","PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY","PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED","PUBLIC_ADMINISTRATION","PUBLIC_ADMINISTRATION_JUDICIAL","REAL_ESTATE","REAL_ESTATE_AGENCY_AND_BROKERAGE","RETAIL_TRADE","RETAIL_TRADE_SPECIALITY","RETAIL_TRADE_SPECIFIC_SECTORS","TRANSPORTATION_AND_LOGISTICS","TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES","TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE","UTILITIES_AND_ENERGY","WHOLESALE_TRADE","WHOLESALE_TRADE_INDUSTRIAL","WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES","WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS"]},"purpose_of_business_relationship":{"title":"Purpose of Business Relationship","type":"string","description":"The purpose of the business relationship.","enum":["WEALTH_GROWTH","TREASURY_LIQUIDITY_MANAGEMENT","HEDGING_RISK_MANAGEMENT","EMPLOYEE_BENEFIT_FUNDING","STRATEGIC_INVESTMENT"]},"primary_countries_of_activity":{"type":"array","description":"List of primary countries where the business operates. ISO 3166-1 alpha-2 country codes.","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"minItems":1},"annual_revenue":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"expected_volume_of_investment":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false},"total_asset_value":{"title":"Monetary Range","type":"object","description":"A monetary range defined by a lower bound and an optional upper bound.","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"lower_bound":{"type":"number","description":"The lower bound of the monetary range.","minimum":0},"upper_bound":{"type":"number","description":"The upper bound of the monetary range.","minimum":0}},"required":["currency","lower_bound"],"additionalProperties":false}},"required":["id","business_id","type","check_confirmed_at","status","business_industry","purpose_of_business_relationship","primary_countries_of_activity","annual_revenue","expected_volume_of_investment","total_asset_value"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_923"},"schema_924":{"kind":"json-schema","data":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"id":"schema_924"},"schema_925":{"kind":"json-schema","data":{"title":"Roles - List - Response","type":"object","description":"Response for listing roles.","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Role","description":"A role assigned to a user for a specific entity (business or account group).","oneOf":[{"title":"Account Group Role","type":"object","description":"Role assignment for an account group.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"ACCOUNT_GROUP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type must be ACCOUNT_GROUP"},"children":[]}]}]}]},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account group owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Guardian for child account groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child user in a child account group"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]},"custody_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custody type for child account groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_CUSTODY - Single guardian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOINT_CUSTODY - Multiple guardians required"},"children":[]}]}]}]}],"enum":["SOLE_CUSTODY","JOINT_CUSTODY"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false},{"title":"Business Role","type":"object","description":"Role assignment for a business entity.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"BUSINESS","description":"Entity type must be BUSINESS"},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for business entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_REPRESENTATIVE - Legal representative of the business"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHORISED_SIGNATORY - Authorised signatory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_BENEFICIAL_OWNER - Ultimate beneficial owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTRACTING_EXECUTIVE - Contracting executive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADER - Trader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_TRADER - Sole trader"},"children":[]}]}]}]}],"enum":["LEGAL_REPRESENTATIVE","AUTHORISED_SIGNATORY","ULTIMATE_BENEFICIAL_OWNER","CONTRACTING_EXECUTIVE","TRADER","SOLE_TRADER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false}]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_925"},"schema_926":{"kind":"json-schema","data":{"title":"Role - Create - Request","description":"Request schema for creating a role.","anyOf":[{"title":"Account Group Role - Create - Request","type":"object","description":"Request to create a role assignment for an account group.","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"ACCOUNT_GROUP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type must be ACCOUNT_GROUP"},"children":[]}]}]}]},"entity_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Guardian for child account groups"},"children":[]}]}]}]}],"enum":["GUARDIAN"]},"custody_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custody type for child account groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_CUSTODY - Single guardian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOINT_CUSTODY - Multiple guardians required"},"children":[]}]}]}]}],"enum":["SOLE_CUSTODY","JOINT_CUSTODY"]}},"required":["user_id","entity_type","entity_id","role_type"],"additionalProperties":false},{"title":"Business Role - Create - Request","type":"object","description":"Request to create a role for a business entity.","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"BUSINESS","description":"Entity type must be BUSINESS"},"entity_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for business entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_REPRESENTATIVE - Legal representative of the business"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHORISED_SIGNATORY - Authorised signatory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_BENEFICIAL_OWNER - Ultimate beneficial owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTRACTING_EXECUTIVE - Contracting executive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADER - Trader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_TRADER - Sole trader"},"children":[]}]}]}]}],"enum":["LEGAL_REPRESENTATIVE","AUTHORISED_SIGNATORY","ULTIMATE_BENEFICIAL_OWNER","CONTRACTING_EXECUTIVE","TRADER","SOLE_TRADER"]}},"required":["user_id","entity_type","entity_id","role_type"],"additionalProperties":false}]},"id":"schema_926"},"schema_927":{"kind":"json-schema","data":{"title":"Role - Create - Response","description":"Response schema for creating a role.","oneOf":[{"title":"Account Group Role - Create - Response","description":"Response schema for creating an account group role.","allOf":[{"title":"Account Group Role","type":"object","description":"Role assignment for an account group.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"ACCOUNT_GROUP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type must be ACCOUNT_GROUP"},"children":[]}]}]}]},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account group owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Guardian for child account groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child user in a child account group"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]},"custody_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custody type for child account groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_CUSTODY - Single guardian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOINT_CUSTODY - Multiple guardians required"},"children":[]}]}]}]}],"enum":["SOLE_CUSTODY","JOINT_CUSTODY"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false},{"type":"object","properties":{"role_type":{"type":"string","description":"Role type for account group.","enum":["GUARDIAN"]}},"required":["role_type"]}]},{"title":"Business Role","type":"object","description":"Role assignment for a business entity.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"BUSINESS","description":"Entity type must be BUSINESS"},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for business entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_REPRESENTATIVE - Legal representative of the business"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHORISED_SIGNATORY - Authorised signatory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_BENEFICIAL_OWNER - Ultimate beneficial owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTRACTING_EXECUTIVE - Contracting executive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADER - Trader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_TRADER - Sole trader"},"children":[]}]}]}]}],"enum":["LEGAL_REPRESENTATIVE","AUTHORISED_SIGNATORY","ULTIMATE_BENEFICIAL_OWNER","CONTRACTING_EXECUTIVE","TRADER","SOLE_TRADER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false}]},"id":"schema_927"},"schema_928":{"kind":"json-schema","data":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"id":"schema_928"},"schema_929":{"kind":"json-schema","data":{"title":"Role - Retrieve - Response","description":"Response schema for retrieving a role.","oneOf":[{"title":"Account Group Role","type":"object","description":"Role assignment for an account group.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"ACCOUNT_GROUP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type must be ACCOUNT_GROUP"},"children":[]}]}]}]},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account group owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Guardian for child account groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child user in a child account group"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]},"custody_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custody type for child account groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_CUSTODY - Single guardian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOINT_CUSTODY - Multiple guardians required"},"children":[]}]}]}]}],"enum":["SOLE_CUSTODY","JOINT_CUSTODY"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false},{"title":"Business Role","type":"object","description":"Role assignment for a business entity.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"BUSINESS","description":"Entity type must be BUSINESS"},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for business entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_REPRESENTATIVE - Legal representative of the business"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHORISED_SIGNATORY - Authorised signatory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_BENEFICIAL_OWNER - Ultimate beneficial owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTRACTING_EXECUTIVE - Contracting executive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADER - Trader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_TRADER - Sole trader"},"children":[]}]}]}]}],"enum":["LEGAL_REPRESENTATIVE","AUTHORISED_SIGNATORY","ULTIMATE_BENEFICIAL_OWNER","CONTRACTING_EXECUTIVE","TRADER","SOLE_TRADER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false}]},"id":"schema_929"},"schema_930":{"kind":"json-schema","data":{"title":"Webhook - Roles - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ROLE.CREATED","ROLE.ACTIVATED","ROLE.DEACTIVATED"]},"object":{"oneOf":[{"title":"Account Group Role","type":"object","description":"Role assignment for an account group.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"ACCOUNT_GROUP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type must be ACCOUNT_GROUP"},"children":[]}]}]}]},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account group owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Guardian for child account groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child user in a child account group"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]},"custody_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custody type for child account groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_CUSTODY - Single guardian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOINT_CUSTODY - Multiple guardians required"},"children":[]}]}]}]}],"enum":["SOLE_CUSTODY","JOINT_CUSTODY"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false},{"title":"Business Role","type":"object","description":"Role assignment for a business entity.","properties":{"id":{"type":"string","description":"Unique identifier for the role.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"entity_type":{"type":"string","default":"BUSINESS","description":"Entity type must be BUSINESS"},"entity_id":{"title":"Entity unique identifier.","type":"string","description":"Unique identifier of the entity a role is attached to.","format":"uuid"},"role_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role type for business entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_REPRESENTATIVE - Legal representative of the business"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHORISED_SIGNATORY - Authorised signatory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_BENEFICIAL_OWNER - Ultimate beneficial owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTRACTING_EXECUTIVE - Contracting executive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADER - Trader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOLE_TRADER - Sole trader"},"children":[]}]}]}]}],"enum":["LEGAL_REPRESENTATIVE","AUTHORISED_SIGNATORY","ULTIMATE_BENEFICIAL_OWNER","CONTRACTING_EXECUTIVE","TRADER","SOLE_TRADER"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the role assignment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Role is not activated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Role is active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED - Role is deactivated"},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","DEACTIVATED"]}},"required":["id","created_at","updated_at","user_id","entity_type","entity_id","role_type","status"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_930"},"schema_931":{"kind":"json-schema","data":{"title":"Tax residency Record","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"tax_residencies":{"type":"array","items":{"title":"Tax residency","oneOf":[{"type":"object","title":"With tax identifier number","properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identifier_number":{"type":"string","maxLength":20,"minLength":1,"description":"Tax identifier number"}},"required":["country","tax_identifier_number"]},{"type":"object","title":"Without tax identifier number","properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"missing_tin_reason":{"type":"string","enum":["TIN_NOT_YET_ASSIGNED","COUNTRY_HAS_NO_TIN","OTHER_REASONS"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason why TIN is missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIN_NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team."},"children":[]}]}]}]}]}},"required":["country","missing_tin_reason"]}]}},"status":{"type":"string","enum":["PENDING","ACTIVE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax residency status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - It indicates that the tax residency records are not yet processed by Upvest."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - It indicates that tax residency records are processed, and the tax residency record is the one in use."},"children":[]}]}]}]}]}},"required":["updated_at","created_at","tax_residencies","status"],"additionalProperties":false},"id":"schema_931"},"schema_932":{"kind":"json-schema","data":{"title":"Tax Residencies - Set - Request","type":"object","properties":{"tax_residencies":{"type":"array","minItems":1,"items":{"title":"Tax residency for Create Request","oneOf":[{"type":"object","title":"With tax identifier number","properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"tax_identifier_number":{"type":"string","maxLength":20,"minLength":1,"description":"Tax identifier number"}},"required":["country","tax_identifier_number"]},{"type":"object","title":"Without tax identifier number","properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"missing_tin_reason":{"type":"string","enum":["TIN_NOT_YET_ASSIGNED","COUNTRY_HAS_NO_TIN","OTHER_REASONS"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason why TIN is missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIN_NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team."},"children":[]}]}]}]}]}},"required":["country","missing_tin_reason"]}]}}},"required":["tax_residencies"],"additionalProperties":false},"id":"schema_932"},"schema_933":{"kind":"json-schema","data":{"title":"Accounts - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_933"},"schema_934":{"kind":"json-schema","data":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"id":"schema_934"},"schema_935":{"kind":"json-schema","data":{"title":"Account - Retrieve - Response","oneOf":[{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false},{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}]},"id":"schema_935"},"schema_936":{"kind":"json-schema","data":{"title":"Account - Update - Request","type":"object","properties":{"name":{"type":"string","description":"The name of the account.","maxLength":100}},"additionalProperties":false},"id":"schema_936"},"schema_937":{"kind":"json-schema","data":{"title":"Account - Update - Response","oneOf":[{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false},{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}]},"id":"schema_937"},"schema_938":{"kind":"json-schema","data":{"title":"Accounts - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"oneOf":[{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false},{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_938"},"schema_939":{"kind":"json-schema","data":{"title":"Account - Create - Request","oneOf":[{"title":"Account - Create - User Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"name":{"type":"string","description":"The name of the account.","maxLength":100}},"required":["user_id","account_group_id","type"],"additionalProperties":false},{"title":"Account - Create - Business Request","type":"object","properties":{"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"name":{"type":"string","description":"The name of the account.","maxLength":100}},"required":["business_id","account_group_id","type"],"additionalProperties":false}]},"id":"schema_939"},"schema_940":{"kind":"json-schema","data":{"title":"Account - Create - Response","oneOf":[{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false},{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}]},"id":"schema_940"},"schema_941":{"kind":"json-schema","data":{"title":"Accounts - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_941"},"schema_942":{"kind":"json-schema","data":{"title":"Webhook - Accounts - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT.CREATED","ACCOUNT.ACTIVATED","ACCOUNT.CLOSING_INITIATED","ACCOUNT.CLOSED","ACCOUNT.LOCKED","ACCOUNT.UPDATED"]},"object":{"oneOf":[{"title":"Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","GUARDIAN","CHILD"]}}}},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","users","name","status","account_number"],"additionalProperties":false},{"title":"Business Account","type":"object","description":"","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING - Orders in accounts of this type are created on a specific instrument basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available."},"children":[]}]}]}]}],"enum":["TRADING","PORTFOLIO"]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1},"name":{"type":"string","description":"The name of the account.","maxLength":100},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account is closed with zero balance successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]}},"required":["id","created_at","updated_at","account_group_id","type","business_id","name","status","account_number"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_942"},"schema_943":{"kind":"json-schema","data":{"title":"Account Groups - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","CHILD","GUARDIAN"]}}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","users","status","type","securities_account_number"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_943"},"schema_944":{"kind":"json-schema","data":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"id":"schema_944"},"schema_945":{"kind":"json-schema","data":{"title":"Account Group - Retrieve - Response","oneOf":[{"title":"Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","CHILD","GUARDIAN"]}}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","users","status","type","securities_account_number"],"additionalProperties":false},{"title":"Business Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","business_id","status","type","securities_account_number"],"additionalProperties":false}]},"id":"schema_945"},"schema_946":{"kind":"json-schema","data":{"type":"string","enum":["dunning","power_of_attorney","loss_of_legal_capacity","aml","risk_based","contract_breach","user_initiated"]},"id":"schema_946"},"schema_947":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_947"},"schema_948":{"kind":"json-schema","data":{"title":"Account Groups - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"oneOf":[{"title":"Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","CHILD","GUARDIAN"]}}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","users","status","type","securities_account_number"],"additionalProperties":false},{"title":"Business Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","business_id","status","type","securities_account_number"],"additionalProperties":false}]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_948"},"schema_949":{"kind":"json-schema","data":{"title":"Account Group - Create - Request","oneOf":[{"title":"Account Group - Create - User Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["user_id","type"],"additionalProperties":false},{"title":"Account Group - Create - Business Request","type":"object","properties":{"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["business_id","type"],"additionalProperties":false}]},"id":"schema_949"},"schema_950":{"kind":"json-schema","data":{"title":"Account Group - Create - Response","oneOf":[{"title":"Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","CHILD","GUARDIAN"]}}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","users","status","type","securities_account_number"],"additionalProperties":false},{"title":"Business Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","business_id","status","type","securities_account_number"],"additionalProperties":false}]},"id":"schema_950"},"schema_951":{"kind":"json-schema","data":{"title":"Account Groups - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Business Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","business_id","status","type","securities_account_number"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_951"},"schema_952":{"kind":"json-schema","data":{"title":"Webhook - Account Groups - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT_GROUP.CREATED","ACCOUNT_GROUP.ACTIVATED","ACCOUNT_GROUP.CLOSING_INITIATED","ACCOUNT_GROUP.CLOSED","ACCOUNT_GROUP.LOCKED","ACCOUNT_GROUP.UPDATED"]},"object":{"oneOf":[{"title":"Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"users":{"type":"array","items":{"type":"object","properties":{"id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relation type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OWNER - Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Child Account Group Owner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUARDIAN - Child Account Group Guardian"},"children":[]}]}]}]}],"enum":["OWNER","CHILD","GUARDIAN"]}}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL - Account group of a person holding assets on their own behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA - Account group of a UK resident holding assets in an individual savings account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHILD - Account group of a child user holding assets in a child account."},"children":[]}]}]}]}],"enum":["PERSONAL","LEGAL_ENTITY","FRENCH_PEA","ISA","CHILD"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","users","status","type","securities_account_number"],"additionalProperties":false},{"title":"Business Account Group","type":"object","description":"","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Account group is active - full functionality of the Investment API is accessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSING - Account group is closing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - Account group is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED - Account group is locked for all actions."},"children":[]}]}]}]}],"enum":["PENDING_APPROVAL","ACTIVE","CLOSING","CLOSED","LOCKED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS - Account group of a business holding assets."},"children":[]}]}]}]}],"enum":["BUSINESS"]},"securities_account_number":{"title":"Securities Account number.","type":"string","description":"Account unique identifier.","format":"^\\d{7,12}$"}},"required":["id","created_at","updated_at","business_id","status","type","securities_account_number"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_952"},"schema_953":{"kind":"json-schema","data":{"title":"Webhook - Corporate Action Notification","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["CORPORATE_ACTION.UPDATED"]},"object":{"title":"Corporate Action","description":"Object representing corporate action and its related processing status","type":"object","additionalProperties":false,"properties":{"id":{"title":"Corporate action unique identifier.","type":"string","description":"Unique internal identifier assigned to a corporate action by Upvest.","format":"uuid"},"corporate_action_reference":{"title":"Corporate action reference","description":"Reference assigned by the account servicer to unambiguously identify a corporate action event.","type":"string"},"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"Unique internal identifier assigned to an instrument by Upvest.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"name":{"description":"Name of the instrument.","type":"string"}}},"iso_type":{"title":"ISO type of corporate action","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of a corporate action type "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/15022/uhb/mt564-5-field-22f.htm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Code"},"children":[]}]}]}]}],"pattern":"^[A-Z]{4}$","type":"string"},"name":{"description":"Name of the corporate action type","type":"string"},"currency_denomination":{"title":"Currency Of Denomination","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency in which a financial instrument is currently denominated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/15022/uhb/mt564-24-field-11a.htm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["UNSPECIFIED","EUR","USD","GBP","SEK","JPY","CHF","CNY","AUD","CAD","HKD","NOK","NZD","AED","AFN","ALL","AMD","ARS","AZN","BAM","BDT","BGN","BHD","BND","BOB","BRL","BYR","BZD","CLP","COP","CRC","CSD","CZK","DKK","DOP","DZD","EEK","EGP","ETB","GEL","GTQ","HNL","HRK","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","KES","KGS","KHR","KRW","KWD","KZT","LAK","LBP","LKR","LTL","LVL","LYD","MAD","MKD","MNT","MOP","MVR","MXN","MYR","NIO","NPR","OMR","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SGD","SYP","THB","TJS","TMT","TND","TRY","TTD","TWD","UAH","UYU","UZS","VEF","VND","XOF","YER","ZAR","ZWL"],"default":"UNSPECIFIED"},"mandatory_voluntary_indicator":{"title":"Mandatory-Voluntary indicator","description":"Indicates whether a corporate action is mandatory, voluntary or choosable.","type":"string","enum":["UNSPECIFIED","MANDATORY","VOLUNTARY","CHOOSABLE"],"default":"UNSPECIFIED"},"announcement_status":{"title":"Announcement status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the completeness of the announcement of a corporate action "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/15022/uhb/mt564-7-field-25d.htm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["UNSPECIFIED","COMPLETE","COMPLETE_UNCONFIRMED","WITH_ENTITLEMENT","PRELIMINARY_ANNOUNCEMENT_CONFIRMED","PRELIMINARY_ANNOUNCEMENT_UNCONFIRMED"],"default":"UNSPECIFIED"},"function_of_message":{"title":"Function of message","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The function of the message is specified in this field. More details under "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/15022/uhb/mt564-4-field-23g.htm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["UNSPECIFIED","ADDITIONAL_BUSINESS_PROCESS","CANCELLATION_ADVICE","NEW","ELIGIBLE_BALANCE_NOTIFICATION","REPLACEMENT","REMINDER","WITHDRAWAL"],"default":"UNSPECIFIED"},"announcement_date":{"title":"Announcement date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date on which a company announces a corporate event. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"ex_date":{"title":"Ex-Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date up to which a particular share is eligible for the upcoming corporate action. If buyers purchase a share on the ex-date, they are not entitled to participate in the upcoming corporate action; but the seller still would be. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"record_date":{"title":"Record date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date on which the issuer reviews its records to determine its authorised shareholders. The authorised shareholders are those who are affected by the respective corporate action. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"buyer_protection_deadline":{"title":"Buyer protection deadline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deadline by which an entitled holder needs to advise their counterparty to a transaction of their election for a corporate action event, also known as Election to Counterparty Market Deadline. Only shown if known. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date-time"},"effective_date":{"title":"Effective date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date at which an event is officially effective from the issuer's perspective (e.g. merger closes, stock split is applied, name change or de-listing becomes effective). Typically present for events that have no ex-date. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"nominal_coupon_rate":{"title":"Nominal coupon rate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bond's fixed annual interest rate (coupon), as a percentage. For example, \"2.5\" means 2.5%. Present only for interest payments on bonds (when iso_type is INTR)."},"children":[]}]}]}],"type":"string"},"options":{"type":"array","items":{"title":"Option","description":"Corporate action option.","type":"object","properties":{"option_number":{"description":"Number to identify the available options for corporate actions.","type":"string"},"option_type":{"title":"Option type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of option based on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/15022/uhb/mt564-57-field-22f.htm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO CAOP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["UNSPECIFIED","ABSTAIN","VOTE_AGAINST_MANAGEMENT","BENEFICIAL_OWNER_BREAKDOWN_REQUEST","BONUS_SHARE_PLAN","BUY_UP","CASH_AND_SECURITIES","CASH","CONSENT_AND_EXCHANGE","CONSENT_DENIED","CONSENT_GRANTED","CONSENT_AND_TENDER","EXERCISE","LAPSE","VOTE_WITH_MANAGEMENT","RETAIN","NO_ACTION","NON_QUALIFIED_INVESTOR","PROPOSED_RATE","OTHER","OVERSUBSCRIBE","PROXY_CARD","UNKNOWN_PROCEEDS","QUALIFIED_INVESTOR","SECURITIES_OPTION","SELL_ENTITLEMENT","SPLIT_INSTRUCTION"],"default":"UNSPECIFIED"},"option_details":{"title":"Option Details","description":"Details of the corporate action option.","type":"object","properties":{"default_option":{"description":"Indicates whether the option is the default option.","type":"string","enum":["TRUE","FALSE"]},"market_deadline":{"title":"Market deadline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer or issuer's agent deadline to respond, including an election instruction to an outstanding offer or privilege. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"client_deadline":{"title":"Client deadline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client deadline to respond to an outstanding offer or privilege. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"action_period_start":{"description":"Start of the period during which the specified option, or all options of the event, remains valid, for example, offer period.","type":"string","format":"date"},"action_period_end":{"description":"End of the period during which the specified option, or all options of the event, remains valid, for example, offer period.","type":"string","format":"date"},"minimum_quantity":{"description":"Minimum quantity of financial instrument that can be instructed.","type":"string"},"minimum_multiple_quantity":{"description":"Minimum of multiple financial instruments that can be instructed.","type":"string"}}},"movements":{"type":"array","items":{"title":"Movement","description":"Movement information for corporate action option.","type":"object","properties":{"movement_type":{"title":"Movement type","description":"Type of the movement.","type":"string","enum":["UNSPECIFIED","CASH","SECURITIES_OPTION"],"default":"UNSPECIFIED"},"movement_details":{"title":"Movement details","description":"Details of the movement.","type":"object","properties":{"credit_debit_factor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the movement is a credit or a debit. DEPRECATED: Use credit_debit_indicator instead."},"children":[]}]}]}],"type":"string","enum":["UNSPECIFIED","CREDIT","DEBIT"],"default":"UNSPECIFIED","deprecated":true},"credit_debit_indicator":{"description":"Indicates whether the movement is a credit or a debit.","type":"string","enum":["UNSPECIFIED","CREDIT","DEBIT"],"default":"UNSPECIFIED"},"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"Unique internal identifier assigned to an instrument by Upvest.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"name":{"description":"Name of the instrument.","type":"string"}}},"ratio":{"title":"Ratio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ratio is the numerical comparison between instruments and can be calculated in two different ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADEX = Additional for Existing Securities. Example: You hold 10 units and the ratio is 1/5. 40 additional units are added."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEWO = New to Old. Example: You hold 1000 units and the ratio is 3/11. 1000 old units are removed and 3666.6 are added."},"children":[]}]}]}]}],"type":"object","properties":{"debit_factor":{"description":"Amount to be decreased.","type":"string"},"credit_factor":{"description":"Amount to be increased.","type":"string"}}},"payment_date":{"title":"Payment date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date on which the movement is due to take place (cash and/or securities). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"value_date":{"title":"Value date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when calculating economic benefit for a cash amount (cash movements only). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"type":"string","format":"date"},"gross_dividend":{"description":"String value, which represents a monetary amount. Amount of the cash dividend per equity before deductions or allowances.","type":"string"},"offer_price_received":{"description":"String value that represents a monetary amount. Generic cash price that the holder of the underlying security receives per product.","type":"string"},"withholding_tax":{"title":"Withholding Tax rate","description":"Withholding tax rate.","type":"string"},"actual_payment_rate":{"title":"Actual payment rate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gross interest rate applied to this payment, as a percentage. For example, \"2.5\" means 2.5%. Present only on cash movements for interest payments (when iso_type is INTR)."},"children":[]}]}]}],"type":"string"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"rounding_indicator":{"title":"Indicator for the rounding approach for the disposition of fractions.","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator for the rounding approach for the disposition of fractions."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNSPECIFIED - The characteristics of the disposition of fractions are not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUYU - Buy securities up to the next whole number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CINL - Receive cash instead of fractions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIST - Accept distribution of fractions in the form of securities."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDDN - Rounds down the entitlement to the last full unit/minimum nominal quantity, fractions are discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDUP - Round up to the next full unit/minimum nominal quantity at no cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STAN - If the fraction is greater than or equal to 0.5 of the resulting security, round up, otherwise round down as specified in the respective RDUP and RDDN codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKWN - The characteristics of the disposition of fractions are unknown. DEPRECATED: Use UNSPECIFIED instead."},"children":[]}]}]}]}],"enum":["UNSPECIFIED","BUYU","CINL","DIST","RDDN","RDUP","STAN","UKWN"],"default":"UNSPECIFIED"}}}}},"minItems":1,"description":"Movements in corporate action option."}}},"minItems":1,"description":"Available corporate action options."},"additional_text":{"title":"Additional text","description":"Provides additional information or specifies in more detail the content of a message.","type":"string"},"website_address":{"title":"Website address","description":"Provides the web address published for the event, if present.","type":"string"}},"required":["id","corporate_action_reference","iso_type","instrument"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_953"},"schema_954":{"kind":"json-schema","data":{"title":"Tax Wrappers - Create ISA Tax Wrapper - Request","type":"object","additionalProperties":false,"properties":{"account_group_id":{"type":"string","format":"uuid","description":"The ID of the account group to which the tax wrapper belongs."},"type":{"type":"string","description":"Types of the ISA tax wrapper","enum":["STOCKS_AND_SHARES_ISA"],"default":"STOCKS_AND_SHARES_ISA"},"is_flexible":{"type":"boolean","description":"True if ISA is flexible."}},"required":["type","account_group_id","is_flexible"]},"id":"schema_954"},"schema_955":{"kind":"json-schema","data":{"title":"Tax Wrappers - ISA Tax Wrapper","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Tax wrapper unique identifier.","format":"uuid"},"created_at":{"type":"string","description":"The date and time the tax wrapper was created.","format":"date-time"},"updated_at":{"type":"string","description":"The date and time the tax wrapper was last updated.","format":"date-time"},"account_group_id":{"type":"string","description":"Account group unique identifier.","format":"uuid"},"is_flexible":{"type":"boolean","description":"True if tax wrapper is flexible."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the tax wrapper"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax wrapper is newly created and not yet active due to pending checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax wrapper is currently active and in use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - The tax wrapper has been closed and is no longer available."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","INACTIVE","CLOSED"]},"type":{"type":"string","description":"Types of the ISA tax wrapper","enum":["STOCKS_AND_SHARES_ISA"],"default":"STOCKS_AND_SHARES_ISA"}},"required":["id","created_at","updated_at","account_group_id","is_flexible","status","type"]},"id":"schema_955"},"schema_956":{"kind":"json-schema","data":{"title":"Tax Wrapper Unique Identifier","type":"string","description":"Tax wrapper unique identifier","format":"uuid"},"id":"schema_956"},"schema_957":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}\\/[0-9]{4}$"},"id":"schema_957"},"schema_958":{"kind":"json-schema","data":{"type":"string","enum":["created_at","valid_from"],"default":"created_at"},"id":"schema_958"},"schema_959":{"kind":"json-schema","data":{"title":"Tax Wrappers - Retrieve ISA Allowances - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Tax Wrappers - ISA Allowance","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Allowance unique identifier.","format":"uuid"},"created_at":{"type":"string","description":"The date and time the tax wrapper was created.","format":"date-time"},"updated_at":{"type":"string","description":"The date and time the tax wrapper was last updated.","format":"date-time"},"tax_wrapper_id":{"type":"string","description":"Tax wrapper unique identifier.","format":"uuid"},"tax_year":{"oneOf":[{"type":"null"},{"type":"string","description":"Tax year the allowance applies to, in the format 'YYYY/YYYY'.","pattern":"^[0-9]{4}/[0-9]{4}$"}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the allowance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL - Allowance valid for a tax year."},"children":[]}]}]}]}],"enum":["ANNUAL"],"default":"ANNUAL"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the allowance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Current allowance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - Allowance from previous years."},"children":[]}]}]}]}],"enum":["ACTIVE","EXPIRED"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound Sterling"},"children":[]}]}]}]}],"enum":["GBP"],"default":"GBP"},"used_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"remaining_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"valid_from":{"type":"string","description":"The date from which the allowance is valid.","format":"date-time"},"valid_to":{"oneOf":[{"type":"null"},{"type":"string","format":"date-time","description":"The date until which the allowance is valid."}]},"first_subscription_at":{"oneOf":[{"type":"null"},{"type":"string","format":"date-time","description":"The date of the first subscription that used this allowance."}]}},"required":["id","created_at","updated_at","tax_wrapper_id","type","status","currency","used_amount","remaining_amount","valid_from"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_959"},"schema_960":{"kind":"json-schema","data":{"title":"Tax Wrappers - ISA Tax Wrapper Event","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"title":"ISA Tax Wrapper Webhook Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of ISA tax wrapper event"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax wrapper is newly created and not yet active due to pending checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax wrapper is currently active and in use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - The tax wrapper has been closed and is no longer available."},"children":[]}]}]}]}],"enum":["ISA_WRAPPER.NEW","ISA_WRAPPER.ACTIVE","ISA_WRAPPER.INACTIVE","ISA_WRAPPER.CLOSED"]},"object":{"title":"Tax Wrappers - ISA Tax Wrapper","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Tax wrapper unique identifier.","format":"uuid"},"created_at":{"type":"string","description":"The date and time the tax wrapper was created.","format":"date-time"},"updated_at":{"type":"string","description":"The date and time the tax wrapper was last updated.","format":"date-time"},"account_group_id":{"type":"string","description":"Account group unique identifier.","format":"uuid"},"is_flexible":{"type":"boolean","description":"True if tax wrapper is flexible."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the tax wrapper"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax wrapper is newly created and not yet active due to pending checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax wrapper is currently active and in use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLOSED - The tax wrapper has been closed and is no longer available."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","INACTIVE","CLOSED"]},"type":{"type":"string","description":"Types of the ISA tax wrapper","enum":["STOCKS_AND_SHARES_ISA"],"default":"STOCKS_AND_SHARES_ISA"}},"required":["id","created_at","updated_at","account_group_id","is_flexible","status","type"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","type","object","webhook_id","created_at"],"additionalProperties":false},"id":"schema_960"},"schema_961":{"kind":"json-schema","data":{"title":"Tax Wrappers - ISA Allowance Event","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"title":"ISA Allowance Webhook Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of ISA allowance event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREATED: Allowance was created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPDATED: Allowance was updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: Allowance is no longer valid."},"children":[]}]}]}]}],"enum":["ISA_WRAPPER_ALLOWANCE.CREATED","ISA_WRAPPER_ALLOWANCE.UPDATED","ISA_WRAPPER_ALLOWANCE.EXPIRED"]},"object":{"title":"Tax Wrappers - ISA Allowance","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Allowance unique identifier.","format":"uuid"},"created_at":{"type":"string","description":"The date and time the tax wrapper was created.","format":"date-time"},"updated_at":{"type":"string","description":"The date and time the tax wrapper was last updated.","format":"date-time"},"tax_wrapper_id":{"type":"string","description":"Tax wrapper unique identifier.","format":"uuid"},"tax_year":{"oneOf":[{"type":"null"},{"type":"string","description":"Tax year the allowance applies to, in the format 'YYYY/YYYY'.","pattern":"^[0-9]{4}/[0-9]{4}$"}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the allowance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL - Allowance valid for a tax year."},"children":[]}]}]}]}],"enum":["ANNUAL"],"default":"ANNUAL"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the allowance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - Current allowance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - Allowance from previous years."},"children":[]}]}]}]}],"enum":["ACTIVE","EXPIRED"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound Sterling"},"children":[]}]}]}]}],"enum":["GBP"],"default":"GBP"},"used_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"remaining_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"valid_from":{"type":"string","description":"The date from which the allowance is valid.","format":"date-time"},"valid_to":{"oneOf":[{"type":"null"},{"type":"string","format":"date-time","description":"The date until which the allowance is valid."}]},"first_subscription_at":{"oneOf":[{"type":"null"},{"type":"string","format":"date-time","description":"The date of the first subscription that used this allowance."}]}},"required":["id","created_at","updated_at","tax_wrapper_id","type","status","currency","used_amount","remaining_amount","valid_from"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","type","object","webhook_id","created_at"],"additionalProperties":false},"id":"schema_961"},"schema_962":{"kind":"json-schema","data":{"type":"object","properties":{"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING - Transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - Transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_INTERNAL - Transfer occurs within the same ISA manager."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_EXTERNAL - Transfer occurs across different ISA managers, via Equisoft or others."},"children":[]}]}]}]}],"enum":["ISA_INTERNAL","ISA_EXTERNAL"]},"transfer_value":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Great British Pound"},"children":[]}]}]}]}],"enum":["GBP"],"default":"GBP"},"transfer_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH - Cash transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other methods can be supported in the future, e.g. IN_SPECIE"},"children":[]}]}]}],"enum":["CASH"]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":"Random string reference on which API clients can build logic."},"counterparty":{"type":"object","properties":{"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"}},"required":["account_number"],"additionalProperties":false},"transfer_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when end user initiated the transfer. Relevant for tax year's end reporting. If not sent it will be the time we create the transfer internally on our side. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"details":{"type":"object","properties":{"current_year_subscription":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details related to the current year’s subscription being transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}],"properties":{"transfer_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"first_subscription_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the first subscription made to the ISA in the current tax year. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}]}},"required":["transfer_amount"],"additionalProperties":false}},"required":["current_year_subscription"],"additionalProperties":false}},"required":["user_id","account_group_id","direction","transfer_type","currency","transfer_method","transfer_date"],"additionalProperties":false},"id":"schema_962"},"schema_963":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"ISA transfer request unique identifier.","type":"string","description":"ISA transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING - Transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - Transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Transfer is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCOVERY - Discovery with the ceding provider where information about the transfer is being exchanged and reviewed. Only relevant if type ISA_EXTERNAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCOVERY_CONFIRMED - Discovery is completed and transfer request is accepted by the ceding provider. Only relevant if type ISA_EXTERNAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUCTED - Transfer is instructed to the ceding provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Transfer instruction is confirmed by the ceding provider. Transfer is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - Transfer is completed."},"children":[]}]}]}]}],"enum":["NEW","DISCOVERY","DISCOVERY_CONFIRMED","INSTRUCTED","PROCESSING","SETTLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_INTERNAL - Transfer occurs within the same ISA manager."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_EXTERNAL - Transfer occurs across different ISA managers, via Equisoft or others."},"children":[]}]}]}]}],"enum":["ISA_INTERNAL","ISA_EXTERNAL"]},"transfer_value":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Great British Pound"},"children":[]}]}]}]}],"enum":["GBP"],"default":"GBP"},"transfer_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH - Cash transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other methods can be supported in the future, e.g. IN_SPECIE"},"children":[]}]}]}],"enum":["CASH"]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":"Random string reference on which API clients can build logic."},"counterparty":{"type":"object","properties":{"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"}},"required":["account_number"],"additionalProperties":false},"transfer_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when end user initiated the transfer. Relevant for tax year's end reporting. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"details":{"type":"object","properties":{"current_year_subscription":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details related to the current year’s subscription being transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}],"properties":{"transfer_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"first_subscription_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the first subscription made to the ISA in the current tax year. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}]}},"required":["transfer_amount"],"additionalProperties":false}},"required":["current_year_subscription"],"additionalProperties":false}},"required":["id","created_at","updated_at","user_id","account_group_id","direction","status","transfer_type","currency","transfer_method","reference","transfer_date"],"additionalProperties":false},"id":"schema_963"},"schema_964":{"kind":"json-schema","data":{"title":"Webhook - Incoming Securities Transfers - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ISA_TRANSFER.NEW","ISA_TRANSFER.DISCOVERY","ISA_TRANSFER.DISCOVERY_CONFIRMED","ISA_TRANSFER.INSTRUCTED","ISA_TRANSFER.PROCESSING","ISA_TRANSFER.SETTLED"]},"object":{"type":"object","properties":{"id":{"title":"ISA transfer request unique identifier.","type":"string","description":"ISA transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING - Transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - Transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Transfer is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCOVERY - Discovery with the ceding provider where information about the transfer is being exchanged and reviewed. Only relevant if type ISA_EXTERNAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCOVERY_CONFIRMED - Discovery is completed and transfer request is accepted by the ceding provider. Only relevant if type ISA_EXTERNAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUCTED - Transfer is instructed to the ceding provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Transfer instruction is confirmed by the ceding provider. Transfer is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - Transfer is completed."},"children":[]}]}]}]}],"enum":["NEW","DISCOVERY","DISCOVERY_CONFIRMED","INSTRUCTED","PROCESSING","SETTLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_INTERNAL - Transfer occurs within the same ISA manager."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_EXTERNAL - Transfer occurs across different ISA managers, via Equisoft or others."},"children":[]}]}]}]}],"enum":["ISA_INTERNAL","ISA_EXTERNAL"]},"transfer_value":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Great British Pound"},"children":[]}]}]}]}],"enum":["GBP"],"default":"GBP"},"transfer_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method of the ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH - Cash transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other methods can be supported in the future, e.g. IN_SPECIE"},"children":[]}]}]}],"enum":["CASH"]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":"Random string reference on which API clients can build logic."},"counterparty":{"type":"object","properties":{"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"}},"required":["account_number"],"additionalProperties":false},"transfer_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when end user initiated the transfer. Relevant for tax year's end reporting. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"details":{"type":"object","properties":{"current_year_subscription":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details related to the current year’s subscription being transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}],"properties":{"transfer_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"first_subscription_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the first subscription made to the ISA in the current tax year. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if transfer_type is ISA_INTERNAL."},"children":[]}]}]}]}},"required":["transfer_amount"],"additionalProperties":false}},"required":["current_year_subscription"],"additionalProperties":false}},"required":["id","created_at","updated_at","user_id","account_group_id","direction","status","transfer_type","currency","transfer_method","reference","transfer_date"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_964"},"schema_965":{"kind":"json-schema","data":{"title":"Taxes - Tax Exemptions - Create - Request","type":"object","additionalProperties":false,"properties":{"user_ids":{"description":"Ids of the users for whom the tax exemption is to be created.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}},"tax_exemption_details":{"title":"Tax Exemption - Request - German Tax Exemption Details","type":"object","additionalProperties":false,"properties":{"tax_exemption_type":{"title":"Tax Exemption Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE - Tax exemption for Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARRIED - Tax exemption for married couples."},"children":[]}]}]}]}],"enum":["SINGLE","MARRIED"]},"tax_exemption_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["tax_exemption_amount"]},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"valid_to_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]}},"required":["user_ids","country","tax_exemption_details"]},"id":"schema_965"},"schema_966":{"kind":"json-schema","data":{"title":"Tax Exemptions - Create - Response","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"}}},"id":"schema_966"},"schema_967":{"kind":"json-schema","data":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"},"id":"schema_967"},"schema_968":{"kind":"json-schema","data":{"title":"Webhook - Tax exemption - Created - Tax exemption","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"status":{"title":"Tax exemption status","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax exemption request is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax exemption is valid and active for the current year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - The tax exemption is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid_to_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already lies in the past. An update is not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The tax exemption could not be created or was cancelled."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","EXPIRED","CANCELLED"]},"user_ids":{"description":"Ids of the users for whom the tax exemption was created.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"valid_from_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the tax exemption is valid. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"valid_to_date":{"type":"string","format":"date","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"tax_exemption_details":{"title":"Tax Exemption - German Tax Exemption Details","type":"object","additionalProperties":false,"properties":{"tax_exemption_type":{"title":"Tax Exemption Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE - Tax exemption for Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARRIED - Tax exemption for married couples."},"children":[]}]}]}]}],"enum":["SINGLE","MARRIED"]},"tax_exemption_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"utilized_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"remaining_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["tax_exemption_type","tax_exemption_amount","utilized_amount","remaining_amount"]}},"required":["id","status","user_ids","country","valid_from_date","valid_to_date","tax_exemption_details","created_at","updated_at"]},"id":"schema_968"},"schema_969":{"kind":"json-schema","data":{"title":"Taxes - Tax Exemptions - Update - Request","type":"object","additionalProperties":false,"properties":{"user_ids":{"description":"Ids of the users for whom the tax exemption is to be updated.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}},"tax_exemption_details":{"title":"Tax Exemption - Request - German Tax Exemption Details","type":"object","additionalProperties":false,"properties":{"tax_exemption_type":{"title":"Tax Exemption Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE - Tax exemption for Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARRIED - Tax exemption for married couples."},"children":[]}]}]}]}],"enum":["SINGLE","MARRIED"]},"tax_exemption_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["tax_exemption_amount"]},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"valid_to_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]}},"required":["user_ids","country","tax_exemption_details"]},"id":"schema_969"},"schema_970":{"kind":"json-schema","data":{"title":"Tax Exemptions - Update - Response","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"}}},"id":"schema_970"},"schema_971":{"kind":"json-schema","data":{"type":"string","enum":["created_at"],"default":"created_at"},"id":"schema_971"},"schema_972":{"kind":"json-schema","data":{"title":"Tax Exemption - Retrieve For User - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Webhook - Tax exemption - Created - Tax exemption","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"status":{"title":"Tax exemption status","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax exemption request is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax exemption is valid and active for the current year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - The tax exemption is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid_to_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already lies in the past. An update is not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The tax exemption could not be created or was cancelled."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","EXPIRED","CANCELLED"]},"user_ids":{"description":"Ids of the users for whom the tax exemption was created.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"valid_from_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the tax exemption is valid. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"valid_to_date":{"type":"string","format":"date","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"tax_exemption_details":{"title":"Tax Exemption - German Tax Exemption Details","type":"object","additionalProperties":false,"properties":{"tax_exemption_type":{"title":"Tax Exemption Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE - Tax exemption for Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARRIED - Tax exemption for married couples."},"children":[]}]}]}]}],"enum":["SINGLE","MARRIED"]},"tax_exemption_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"utilized_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"remaining_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["tax_exemption_type","tax_exemption_amount","utilized_amount","remaining_amount"]}},"required":["id","status","user_ids","country","valid_from_date","valid_to_date","tax_exemption_details","created_at","updated_at"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_972"},"schema_973":{"kind":"json-schema","data":{"title":"Webhook - Tax Exemptions - Updated","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"title":"Tax Exemption Update Webhook Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption events webhook type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.CREATED - Tax exemption successfully created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.UPDATED - Tax exemption successfully updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.DELETED - Tax exemption successfully deleted."},"children":[]}]}]}]}],"enum":["TAX_EXEMPTION.CREATED","TAX_EXEMPTION.UPDATED","TAX_EXEMPTION.DELETED"]},"object":{"title":"Webhook - Tax exemption - Created - Tax exemption","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"status":{"title":"Tax exemption status","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax exemption request is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax exemption is valid and active for the current year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - The tax exemption is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid_to_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already lies in the past. An update is not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The tax exemption could not be created or was cancelled."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","EXPIRED","CANCELLED"]},"user_ids":{"description":"Ids of the users for whom the tax exemption was created.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"valid_from_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the tax exemption is valid. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"valid_to_date":{"type":"string","format":"date","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]}]}]}]},"tax_exemption_details":{"title":"Tax Exemption - German Tax Exemption Details","type":"object","additionalProperties":false,"properties":{"tax_exemption_type":{"title":"Tax Exemption Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE - Tax exemption for Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARRIED - Tax exemption for married couples."},"children":[]}]}]}]}],"enum":["SINGLE","MARRIED"]},"tax_exemption_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"utilized_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"remaining_amount":{"title":"Tax Exemption - Create - Request - Tax Exemption Details - Amount","type":"object","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["tax_exemption_type","tax_exemption_amount","utilized_amount","remaining_amount"]}},"required":["id","status","user_ids","country","valid_from_date","valid_to_date","tax_exemption_details","created_at","updated_at"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_973"},"schema_974":{"kind":"json-schema","data":{"title":"Webhook - Tax Exemptions - Update Failed","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"title":"Tax Exemption Update Webhook Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax exemption failure events webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.CREATION_FAILED - Tax exemption creation failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.UPDATE_FAILED - Tax exemption update failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_EXEMPTION.DELETION_FAILED - Tax exemption deletion failed."},"children":[]}]}]}]}],"enum":["TAX_EXEMPTION.CREATION_FAILED","TAX_EXEMPTION.UPDATE_FAILED","TAX_EXEMPTION.DELETION_FAILED"]},"object":{"title":"Webhook - Tax exemption - Created - Tax exemption","type":"object","additionalProperties":false,"properties":{"id":{"title":"Tax Exemption Unique Identifier","type":"string","description":"Tax Exemption Unique Identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"reason":{"type":"string","description":"Reason for the failure of the tax exemption request."},"status":{"title":"Tax exemption status","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax exemption status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - The tax exemption request is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The tax exemption is valid and active for the current year."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED - The tax exemption is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid_to_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already lies in the past. An update is not possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The tax exemption could not be created or was cancelled."},"children":[]}]}]}]}],"enum":["NEW","ACTIVE","EXPIRED","CANCELLED"]},"user_ids":{"description":"Ids of the users for whom the tax exemption was created.","type":"array","items":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}}},"required":["id","reason","status","user_ids","created_at","updated_at"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_974"},"schema_975":{"kind":"json-schema","data":{"title":"Webhook - Tax Collection - Updated","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"title":"Tax Collection Webhook Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax collection webhook type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_COLLECTION.CREATED - Tax collection processing started successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_COLLECTION.FINALISED - Tax collection processing finalised successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_COLLECTION.CANCELLED - Tax collection processing cancelled successfully."},"children":[]}]}]}]}],"enum":["TAX_COLLECTION.CREATED","TAX_COLLECTION.FINALISED","TAX_COLLECTION.CANCELLED"]},"object":{"title":"Webhook - Tax collection","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Tax Collection Unique Identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"type":"string","description":"Account Group Unique Identifier","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German preliminary lump-sum tax payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment"},"children":[]}]}]}]}],"enum":["TAX_PREPAYMENT_DE","TAX_PAYMENT"]},"collection_amount":{"type":"object","description":"Total amount of taxes to be collected","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"instrument":{"type":"object","description":"Instrument details","additionalProperties":false,"properties":{"uuid":{"type":"string","description":"Instrument Unique Identifier","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid","isin"]},"processed_amount":{"type":"object","description":"Processed amount details","additionalProperties":false,"properties":{"cash_balance":{"type":"object","description":"Taxes collected from the cash balance","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"sell_to_cover":{"type":"object","description":"Taxes collected by selling assets","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]},"offset_amount":{"type":"object","description":"Taxes collected by offsetting automatic corrections","additionalProperties":false,"properties":{"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"]}},"required":["cash_balance","sell_to_cover","offset_amount"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax collection status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - The tax collection processing has started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINALISED - The tax collection has been processed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The tax collection was cancelled."},"children":[]}]}]}]}],"enum":["PROCESSING","FINALISED","CANCELLED"]},"references":{"type":"array","items":{"type":"object","description":"Identifier related to the tax collection.","additionalProperties":false,"properties":{"id":{"type":"string","description":"Referenced Identifier"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the referenced identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTERNAL_TAX_TRANSACTION_ID - External tax transaction ID"},"children":[]}]}]}]}],"enum":["EXTERNAL_TAX_TRANSACTION_ID"]}},"required":["id","type"]}}},"required":["id","created_at","updated_at","type","collection_amount","processed_amount","status"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_975"},"schema_976":{"kind":"json-schema","data":{"title":"Instrument trading status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument trading status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The instrument can currently be traded on the Upvest platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The instrument cannot currently be traded on the Upvest platform."},"children":[]}]}]}]}],"type":"string","enum":["ACTIVE","INACTIVE"]},"id":"schema_976"},"schema_977":{"kind":"json-schema","data":{"title":"Instruments - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Instrument unique identifier.","type":"string","description":"Instrument unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"wkn":{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"},"name":{"description":"Instrument name","type":"string","maxLength":100},"fractional_trading":{"type":"boolean","description":"Determines whether the platform can handle fractional investments within this instrument."},"trading_status":{"title":"Instrument trading status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument trading status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The instrument can currently be traded on the Upvest platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The instrument cannot currently be traded on the Upvest platform."},"children":[]}]}]}]}],"type":"string","enum":["ACTIVE","INACTIVE"]},"details":{"title":"Details","type":"object","description":"Details","properties":{"distribution_countries":{"title":"Distribution Countries","description":"Distribution Countries","type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"}}}}},"required":["id","name","fractional_trading","trading_status","created_at","updated_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_977"},"schema_978":{"kind":"json-schema","data":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number with 'isin:' URN namespace","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", prefixed with a 'isin:' "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc8141"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URN scheme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Universally Unique IDentifier (UUID) with 'uuid:' URN scheme","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Universally Unique IDentifier (UUID) with 'uuid:' URN namespace, defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc4122"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 4122"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^(urn:)?uuid:[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"id":"schema_978"},"schema_979":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Instrument unique identifier.","type":"string","description":"Instrument unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"wkn":{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"},"name":{"description":"Instrument name","type":"string","maxLength":100},"fractional_trading":{"type":"boolean","description":"Determines whether the platform can handle fractional investments within this instrument."},"trading_status":{"title":"Instrument trading status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument trading status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The instrument can currently be traded on the Upvest platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The instrument cannot currently be traded on the Upvest platform."},"children":[]}]}]}]}],"type":"string","enum":["ACTIVE","INACTIVE"]},"details":{"title":"Details","type":"object","description":"Details","properties":{"distribution_countries":{"title":"Distribution Countries","description":"Distribution Countries","type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"}}}}},"required":["id","name","fractional_trading","trading_status","created_at","updated_at"],"additionalProperties":false},"id":"schema_979"},"schema_980":{"kind":"json-schema","data":{"title":"Webhook - Instruments - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["INSTRUMENT.ONBOARDED","INSTRUMENT.ACTIVATED","INSTRUMENT.DEACTIVATED","INSTRUMENT.FRACTIONAL_TRADING_ENABLED","INSTRUMENT.FRACTIONAL_TRADING_DISABLED","INSTRUMENT.DATA_CHANGED"]},"object":{"type":"object","properties":{"id":{"title":"Instrument unique identifier.","type":"string","description":"Instrument unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"wkn":{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"},"name":{"description":"Instrument name","type":"string","maxLength":100},"fractional_trading":{"type":"boolean","description":"Determines whether the platform can handle fractional investments within this instrument."},"trading_status":{"title":"Instrument trading status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument trading status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE - The instrument can currently be traded on the Upvest platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE - The instrument cannot currently be traded on the Upvest platform."},"children":[]}]}]}]}],"type":"string","enum":["ACTIVE","INACTIVE"]},"details":{"title":"Details","type":"object","description":"Details","properties":{"distribution_countries":{"title":"Distribution Countries","description":"Distribution Countries","type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"}}}}},"required":["id","name","fractional_trading","trading_status","created_at","updated_at"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_980"},"schema_981":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"Venue","title":"Venue","properties":{"name":{"description":"The name of venue.","title":"The name of venue.","type":"string"},"id":{"title":"Venue unique identifier.","type":"string","description":"Venue unique identifier.","format":"uuid"},"price_qualities":{"type":"array","description":"The available price qualities.","items":{"type":"string","enum":["EOD","REALTIME","DELAYED"]}}},"required":["id"]}}},"required":["data"],"additionalProperties":false},"id":"schema_981"},"schema_982":{"kind":"json-schema","data":{"title":"Venue unique identifier.","type":"string","description":"Venue unique identifier.","format":"uuid"},"id":"schema_982"},"schema_983":{"kind":"json-schema","data":{"type":"string","enum":["HIGHEST_AVAILABLE"],"default":"HIGHEST_AVAILABLE","example":"HIGHEST_AVAILABLE"},"id":"schema_983"},"schema_984":{"kind":"json-schema","data":{"type":"object","properties":{"price_quality":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The retrieved price quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALTIME -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELAYED -"},"children":[]}]}]}]}],"enum":["REALTIME","DELAYED"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"bids":{"description":"Bids for the instrument.","type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of data capture. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"price":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"size":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}}}},"asks":{"description":"Asks for the instrument.","type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of data capture. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"price":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"size":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}}}},"last_trade":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of data capture. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"price":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"size":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}}}},"required":["price_quality","currency"],"additionalProperties":false},"id":"schema_984"},"schema_985":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date and time formatted as YYYY-MM-DD[THH:mm:ssZ]. The time part is optional. RFC 3339, section 5.6."},"id":"schema_985"},"schema_986":{"kind":"json-schema","data":{"type":"string","enum":["NONE","ALL"],"default":"ALL"},"id":"schema_986"},"schema_987":{"kind":"json-schema","data":{"type":"string","default":"1d","title":"Format is 1d for daily prices or any positive integer followed by h or m for hour or minute, respectively.","pattern":"^1d|[1-9][0-9]*[hm]$"},"id":"schema_987"},"schema_988":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time indicating start of the interval. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"open":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"close":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"high":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"low":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"volume":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","description":"Count of the resources returned in the response."}}}},"required":["data","meta"],"additionalProperties":false},"id":"schema_988"},"schema_989":{"kind":"json-schema","data":{"type":"string","enum":["NEW","PROCESSING","FILLED","CANCELLED"],"default":"FILLED"},"id":"schema_989"},"schema_990":{"kind":"json-schema","data":{"type":"string","format":"date-time","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6"},"id":"schema_990"},"schema_991":{"kind":"json-schema","data":{"title":"Orders - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_991"},"schema_992":{"kind":"json-schema","data":{"title":"Order - Place - Request","type":"object","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["account_id","side","instrument_id","instrument_id_type"],"additionalProperties":false},"id":"schema_992"},"schema_993":{"kind":"json-schema","data":{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},"id":"schema_993"},"schema_994":{"kind":"json-schema","data":{"title":"Order unique identifier","type":"string","format":"uuid"},"id":"schema_994"},"schema_995":{"kind":"json-schema","data":{"title":"Order - Cancel - Response","type":"object","description":"","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"id":"schema_995"},"schema_996":{"kind":"json-schema","data":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"id":"schema_996"},"schema_997":{"kind":"json-schema","data":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false},"id":"schema_997"},"schema_998":{"kind":"json-schema","data":{"title":"Webhook - Orders - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ORDER.NEW","ORDER.PROCESSING","ORDER.FILLED","ORDER.CANCELLED"]},"object":{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_998"},"schema_999":{"kind":"json-schema","data":{"title":"Webhook - Executions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["EXECUTION.FILLED","EXECUTION.SETTLED","EXECUTION.CANCELLED"]},"object":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_999"},"schema_1000":{"kind":"json-schema","data":{"title":"Webhook - Order Cancellations - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ORDER_CANCELLATION.REJECTED"]},"object":{"title":"Order Cancellation","type":"object","description":"","properties":{"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":"Status of the order cancellation process","enum":["REJECTED"]},"reason":{"type":"string","description":"Reason behind order cancellation rejection."}},"required":["order_id","status"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1000"},"schema_1001":{"kind":"json-schema","data":{"type":"string","enum":["id"],"default":"id"},"id":"schema_1001"},"schema_1002":{"kind":"json-schema","data":{"type":"string","enum":["ASC"],"default":"ASC"},"id":"schema_1002"},"schema_1003":{"kind":"json-schema","data":{"type":"string","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6"},"id":"schema_1003"},"schema_1004":{"kind":"json-schema","data":{"title":"Portfolios allocations - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Portfolios allocation","type":"object","properties":{"id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"name":{"description":"Allocation name","type":"string"},"allocation":{"description":"List of portfolios allocations","type":"array","items":{"type":"object","properties":{"instrument_id":{"oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier","description":"UPVEST instrument identifier","type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST - UPVEST's unique instrument identifier"},"children":[]}]}]}]}],"enum":["ISIN","UPVEST"],"default":"ISIN","type":"string"},"weight":{"description":"Instrument allocation weight","type":"string","pattern":"^(100|[0-9]{1,2}(\\.[0-9]{1,5})?)$"}},"required":["instrument_id","instrument_id_type","weight"],"additionalProperties":false}}},"required":["id","created_at","updated_at","name","allocation"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1004"},"schema_1005":{"kind":"json-schema","data":{"title":"Portfolios allocation - Create - Request","type":"object","properties":{"name":{"description":"Allocation name","type":"string"},"allocation":{"description":"List of portfolios allocations","type":"array","items":{"type":"object","properties":{"instrument_id":{"oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier","description":"UPVEST instrument identifier","type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST - UPVEST's unique instrument identifier"},"children":[]}]}]}]}],"enum":["ISIN","UPVEST"],"default":"ISIN","type":"string"},"weight":{"description":"Instrument allocation weight","type":"string","pattern":"^(100|[0-9]{1,2}(\\.[0-9]{1,5})?)$"}},"required":["instrument_id","instrument_id_type","weight"],"additionalProperties":false}},"rebalancing_strategy_ids":{"description":"List of rebalancing strategy ids","type":"array","items":{"title":"Portfolio rebalancing strategy unique identifier","type":"string","format":"uuid"}}},"required":["allocation"],"additionalProperties":false},"id":"schema_1005"},"schema_1006":{"kind":"json-schema","data":{"title":"Portfolios allocation","type":"object","properties":{"id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"name":{"description":"Allocation name","type":"string"},"allocation":{"description":"List of portfolios allocations","type":"array","items":{"type":"object","properties":{"instrument_id":{"oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier","description":"UPVEST instrument identifier","type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST - UPVEST's unique instrument identifier"},"children":[]}]}]}]}],"enum":["ISIN","UPVEST"],"default":"ISIN","type":"string"},"weight":{"description":"Instrument allocation weight","type":"string","pattern":"^(100|[0-9]{1,2}(\\.[0-9]{1,5})?)$"}},"required":["instrument_id","instrument_id_type","weight"],"additionalProperties":false}}},"required":["id","created_at","updated_at","name","allocation"],"additionalProperties":false},"id":"schema_1006"},"schema_1007":{"kind":"json-schema","data":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"id":"schema_1007"},"schema_1008":{"kind":"json-schema","data":{"title":"Portfolios allocation - Update - Request","type":"object","properties":{"name":{"description":"Allocation name","type":"string"},"allocation":{"description":"List of portfolios allocations","type":"array","items":{"type":"object","properties":{"instrument_id":{"oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier","description":"UPVEST instrument identifier","type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST - UPVEST's unique instrument identifier"},"children":[]}]}]}]}],"enum":["ISIN","UPVEST"],"default":"ISIN","type":"string"},"weight":{"description":"Instrument allocation weight","type":"string","pattern":"^(100|[0-9]{1,2}(\\.[0-9]{1,5})?)$"}},"required":["instrument_id","instrument_id_type","weight"],"additionalProperties":false}}},"required":["allocation"],"additionalProperties":false},"id":"schema_1008"},"schema_1009":{"kind":"json-schema","data":{"type":"string","enum":["account_id"],"default":"account_id"},"id":"schema_1009"},"schema_1010":{"kind":"json-schema","data":{"title":"Portfolios configurations - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Portfolios configuration","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"rebalancing_strategy_ids":{"description":"List of rebalancing strategy ids","type":"array","items":{"title":"Portfolio rebalancing strategy unique identifier","type":"string","format":"uuid"}}},"required":["created_at","updated_at","account_id","allocation_id"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1010"},"schema_1011":{"kind":"json-schema","data":{"title":"Portfolios configuration - Create - Request","type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"rebalancing_strategy_ids":{"description":"List of rebalancing strategy ids","type":"array","items":{"title":"Portfolio rebalancing strategy unique identifier","type":"string","format":"uuid"}}},"required":["account_id","allocation_id"],"additionalProperties":false},"id":"schema_1011"},"schema_1012":{"kind":"json-schema","data":{"title":"Portfolios configuration","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"rebalancing_strategy_ids":{"description":"List of rebalancing strategy ids","type":"array","items":{"title":"Portfolio rebalancing strategy unique identifier","type":"string","format":"uuid"}}},"required":["created_at","updated_at","account_id","allocation_id"],"additionalProperties":false},"id":"schema_1012"},"schema_1013":{"kind":"json-schema","data":{"title":"Portfolios configuration - Update - Request","type":"object","properties":{"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"rebalancing_strategy_ids":{"description":"List of rebalancing strategy ids","type":"array","items":{"title":"Portfolio rebalancing strategy unique identifier","type":"string","format":"uuid"}}},"additionalProperties":false},"id":"schema_1013"},"schema_1014":{"kind":"json-schema","data":{"title":"Portfolios orders - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REBALANCING -"},"children":[]}]}]}]}],"enum":["BUY","SELL","REBALANCING"]},"post_tax":{"type":"boolean","description":"Cash amount is post-tax value","default":false},"orders":{"type":"array","description":"Orders associated with this portfolio order","items":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the portfolio order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"client_reference":{"title":"An ID provided by the client","type":"string"},"initiation_flow":{"title":"Initiation flow used during order creation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What triggered the order creation ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]}]}],"type":"string","enum":["API","SAVINGS_PLAN"]},"cancellation_reason":{"title":"Cancellation reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the order was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_IS_EMPTY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_IS_BALANCED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_LIMIT_EXCEEDED -"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_IS_EMPTY","CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST","PORTFOLIO_IS_BALANCED","SELL_LIMIT_EXCEEDED"]},"cancellation_details":{"type":"string"}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","post_tax","client_reference","initiation_flow","orders"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1014"},"schema_1015":{"kind":"json-schema","data":{"title":"Portfolios order - Place - Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the portfolio order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"post_tax":{"type":"boolean","description":"Cash amount is post-tax value","default":false}},"required":["user_id","account_id","side","cash_amount","currency"],"additionalProperties":false},"id":"schema_1015"},"schema_1016":{"kind":"json-schema","data":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REBALANCING -"},"children":[]}]}]}]}],"enum":["BUY","SELL","REBALANCING"]},"post_tax":{"type":"boolean","description":"Cash amount is post-tax value","default":false},"orders":{"type":"array","description":"Orders associated with this portfolio order","items":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the portfolio order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"client_reference":{"title":"An ID provided by the client","type":"string"},"initiation_flow":{"title":"Initiation flow used during order creation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What triggered the order creation ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]}]}],"type":"string","enum":["API","SAVINGS_PLAN"]},"cancellation_reason":{"title":"Cancellation reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the order was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_IS_EMPTY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_IS_BALANCED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_LIMIT_EXCEEDED -"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_IS_EMPTY","CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST","PORTFOLIO_IS_BALANCED","SELL_LIMIT_EXCEEDED"]},"cancellation_details":{"type":"string"}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","post_tax","client_reference","initiation_flow","orders"],"additionalProperties":false},"id":"schema_1016"},"schema_1017":{"kind":"json-schema","data":{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},"id":"schema_1017"},"schema_1018":{"kind":"json-schema","data":{"title":"Portfolios allocation accounts - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Portfolios allocation account","type":"object","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}},"required":["id"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1018"},"schema_1019":{"kind":"json-schema","data":{"title":"Webhook - Portfolios Orders - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["PORTFOLIO_ORDER.NEW","PORTFOLIO_ORDER.PROCESSING","PORTFOLIO_ORDER.FILLED","PORTFOLIO_ORDER.SETTLED","PORTFOLIO_ORDER.CANCELLED"]},"object":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"allocation_id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Portfolio Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REBALANCING -"},"children":[]}]}]}]}],"enum":["BUY","SELL","REBALANCING"]},"post_tax":{"type":"boolean","description":"Cash amount is post-tax value","default":false},"orders":{"type":"array","description":"Orders associated with this portfolio order","items":{"title":"Portfolios order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the portfolio order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"client_reference":{"title":"An ID provided by the client","type":"string"},"initiation_flow":{"title":"Initiation flow used during order creation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What triggered the order creation ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]}]}],"type":"string","enum":["API","SAVINGS_PLAN"]},"cancellation_reason":{"title":"Cancellation reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the order was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_IS_EMPTY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_IS_BALANCED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_LIMIT_EXCEEDED -"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_IS_EMPTY","CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST","PORTFOLIO_IS_BALANCED","SELL_LIMIT_EXCEEDED"]},"cancellation_details":{"type":"string"}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","post_tax","client_reference","initiation_flow","orders"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1019"},"schema_1020":{"kind":"json-schema","data":{"title":"Webhook - Portfolios Orders - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["PORTFOLIO_ALLOCATION.CREATED","PORTFOLIO_ALLOCATION.CHANGED"]},"object":{"title":"Portfolios allocation","type":"object","properties":{"id":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"name":{"description":"Allocation name","type":"string"},"allocation":{"description":"List of portfolios allocations","type":"array","items":{"type":"object","properties":{"instrument_id":{"oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier","description":"UPVEST instrument identifier","type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$"}]},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST - UPVEST's unique instrument identifier"},"children":[]}]}]}]}],"enum":["ISIN","UPVEST"],"default":"ISIN","type":"string"},"weight":{"description":"Instrument allocation weight","type":"string","pattern":"^(100|[0-9]{1,2}(\\.[0-9]{1,5})?)$"}},"required":["instrument_id","instrument_id_type","weight"],"additionalProperties":false}}},"required":["id","created_at","updated_at","name","allocation"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1020"},"schema_1021":{"kind":"json-schema","data":{"title":"Trigger portfolio rebalancing - Request","oneOf":[{"title":"Accounts","type":"object","properties":{"accounts":{"type":"array","description":"List of accounts","items":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"required":["accounts"],"additionalProperties":false},{"title":"Allocations","type":"object","properties":{"allocations":{"type":"array","description":"List of allocations","items":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"}}},"required":["allocations"],"additionalProperties":false}]},"id":"schema_1021"},"schema_1022":{"kind":"json-schema","data":{"title":"Trigger portfolio rebalancing - Response","type":"object","properties":{"id":{"title":"Portfolio rebalancing execution unique identifier","type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"id":"schema_1022"},"schema_1023":{"kind":"json-schema","data":{"title":"Portfolios rebalancing execution","type":"object","properties":{"id":{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"accounts":{"type":"array","description":"Accounts associated with this rebalancing execution","items":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}},"allocations":{"type":"array","description":"Allocations associated with this rebalancing execution","items":{"title":"Portfolio allocation unique identifier","type":"string","format":"uuid"}}},"required":["id","created_at","updated_at"],"additionalProperties":false},"id":"schema_1023"},"schema_1024":{"kind":"json-schema","data":{"type":"string","enum":["status"],"default":"status"},"id":"schema_1024"},"schema_1025":{"kind":"json-schema","data":{"title":"Portfolios rebalancing execution order - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Portfolios rebalancing execution order","type":"object","properties":{"id":{"title":"Rebalancing execution order unique identifier","type":"string","format":"uuid"},"execution_id":{"title":"Portfolio rebalancing execution unique identifier","type":"string","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"portfolio_order_id":{"oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the Rebalancing Execution Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Rebalancing Execution Order Cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_IS_EMPTY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_NOT_FOUND -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIGURATION_IS_MISSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ACCOUNT_TYPE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_IS_BALANCED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNKNOWN -"},"children":[]}]}]}]}],"enum":["ACCOUNT_IS_EMPTY","ACCOUNT_NOT_FOUND","CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST","CONFIGURATION_IS_MISSING","INVALID_ACCOUNT_TYPE","PORTFOLIO_IS_BALANCED","UNKNOWN"]},"cancellation_details":{"type":"string"}},"required":["id","execution_id","account_id","portfolio_order_id","status","created_at","updated_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1025"},"schema_1026":{"kind":"json-schema","data":{"title":"Webhook - Portfolio Rebalancing Execution Order - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["REBALANCING_EXECUTION_ORDER.NEW","REBALANCING_EXECUTION_ORDER.PROCESSING","REBALANCING_EXECUTION_ORDER.CANCELLED","REBALANCING_EXECUTION_ORDER.FILLED"]},"object":{"title":"Portfolios rebalancing execution order","type":"object","properties":{"id":{"title":"Rebalancing execution order unique identifier","type":"string","format":"uuid"},"execution_id":{"title":"Portfolio rebalancing execution unique identifier","type":"string","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"portfolio_order_id":{"oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"type":"null"}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the Rebalancing Execution Order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Rebalancing Execution Order Cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_IS_EMPTY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_NOT_FOUND -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIGURATION_IS_MISSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ACCOUNT_TYPE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_IS_BALANCED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNKNOWN -"},"children":[]}]}]}]}],"enum":["ACCOUNT_IS_EMPTY","ACCOUNT_NOT_FOUND","CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST","CONFIGURATION_IS_MISSING","INVALID_ACCOUNT_TYPE","PORTFOLIO_IS_BALANCED","UNKNOWN"]},"cancellation_details":{"type":"string"}},"required":["id","execution_id","account_id","portfolio_order_id","status","created_at","updated_at"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1026"},"schema_1027":{"kind":"json-schema","data":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"id":"schema_1027"},"schema_1028":{"kind":"json-schema","data":{"title":"Savings plan (instrument)","type":"object","properties":{"id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Savings plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUMENT -"},"children":[]}]}]}]}],"enum":["PORTFOLIO","INSTRUMENT"]},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["ACTIVE","CANCELLED"]},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"description":"Additional details about the cancellation","type":"string"}},"required":["id","user_id","account_id","type","cash_amount","currency","start_date","period","interval","created_at","updated_at"],"additionalProperties":false},"id":"schema_1028"},"schema_1029":{"kind":"json-schema","data":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"id":"schema_1029"},"schema_1030":{"kind":"json-schema","data":{"title":"Savings plan - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Savings plan (instrument)","type":"object","properties":{"id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Savings plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUMENT -"},"children":[]}]}]}]}],"enum":["PORTFOLIO","INSTRUMENT"]},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["ACTIVE","CANCELLED"]},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"description":"Additional details about the cancellation","type":"string"}},"required":["id","user_id","account_id","type","cash_amount","currency","start_date","period","interval","created_at","updated_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1030"},"schema_1031":{"kind":"json-schema","data":{"title":"Savings plan - Create - Request","anyOf":[{"title":"Savings plan (portfolio)","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","default":"PORTFOLIO","description":"The type of savings plan must be \"PORTFOLIO\"."},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000}},"required":["user_id","account_id","type","cash_amount","currency","start_date","period","interval"],"additionalProperties":false},{"title":"Savings plan (instrument)","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","default":"INSTRUMENT","description":"The type of savings plan must be \"INSTRUMENT\"."},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}}},"required":["user_id","account_id","type","cash_amount","currency","start_date","period","interval"],"additionalProperties":false}]},"id":"schema_1031"},"schema_1032":{"kind":"json-schema","data":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"id":"schema_1032"},"schema_1033":{"kind":"json-schema","data":{"title":"Savings plan execution","anyOf":[{"title":"Savings plan execution (instrument)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"INSTRUMENT","description":"The type of savings plan must be \"INSTRUMENT\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false},{"title":"Savings plan execution (portfolio)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"PORTFOLIO","description":"The type of savings plan must be \"PORTFOLIO\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false}]},"id":"schema_1033"},"schema_1034":{"kind":"json-schema","data":{"type":"string","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns savings plan executions starting from and including this date (UTC)"},"id":"schema_1034"},"schema_1035":{"kind":"json-schema","data":{"type":"string","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns savings plan executions up to this date (UTC)"},"id":"schema_1035"},"schema_1036":{"kind":"json-schema","data":{"type":"string","enum":["execution_date","created_at","updated_at"],"default":"execution_date"},"id":"schema_1036"},"schema_1037":{"kind":"json-schema","data":{"title":"Savings plan execution - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Savings plan execution","anyOf":[{"title":"Savings plan execution (instrument)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"INSTRUMENT","description":"The type of savings plan must be \"INSTRUMENT\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false},{"title":"Savings plan execution (portfolio)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"PORTFOLIO","description":"The type of savings plan must be \"PORTFOLIO\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false}]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1037"},"schema_1038":{"kind":"json-schema","data":{"title":"Webhook - Savings Plan Executions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["SAVINGS_PLAN_EXECUTION.NEW","SAVINGS_PLAN_EXECUTION.PROCESSING","SAVINGS_PLAN_EXECUTION.FILLED","SAVINGS_PLAN_EXECUTION.SETTLED","SAVINGS_PLAN_EXECUTION.CANCELLED","SAVINGS_PLAN_EXECUTION.REMINDER","SAVINGS_PLAN_EXECUTION.DATA_CHANGED"]},"object":{"title":"Savings plan execution","anyOf":[{"title":"Savings plan execution (instrument)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"INSTRUMENT","description":"The type of savings plan must be \"INSTRUMENT\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false},{"title":"Savings plan execution (portfolio)","type":"object","properties":{"id":{"title":"Savings plan execution unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"savings_plan_id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"order_id":{"title":"Order unique identifier (Portfolio order or Instrument order)","description":"Order unique identifier (Portfolio order or Instrument order)","oneOf":[{"title":"Portfolios order unique identifier","type":"string","format":"uuid"},{"title":"Order","type":"object","properties":{"id":{"title":"Order unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"type":"string","format":"uuid","description":"The ID of the user. Either user ID or business ID must be specified."},"business_id":{"type":"string","format":"uuid","description":"The ID of the business. Either user ID or business ID must be specified."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order"},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order, not required if a share quantity is specified."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order. Only required if the cash amount is not specified."}]},"user_instrument_fit_acknowledgement":{"type":"boolean","description":"Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade."},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"expiry_date":{"allOf":[{"title":"Expiry date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339. The default value is order creation date + 359 days"},"children":[]}]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution status of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]},"fee":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_TRADING_PARTNER -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST_PLATFORM -"},"children":[]}]}]}]}],"enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST_OPERATIONS","CANCELLED_BY_TRADING_PARTNER","CANCELLED_BY_UPVEST_PLATFORM"]},"initiation_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiation flow used during order creation, i.e. what triggered the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_REINVESTMENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO_REBALANCING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_FEES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_TO_COVER_TAXES -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_LIQUIDATION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPVEST_OPERATIONS -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS_PLAN -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLIENT_OPERATIONS -"},"children":[]}]}]}]}],"enum":["API","PORTFOLIO","CASH_DIVIDEND_REINVESTMENT","PORTFOLIO_REBALANCING","SELL_TO_COVER_FEES","SELL_TO_COVER_TAXES","ACCOUNT_LIQUIDATION","UPVEST_OPERATIONS","SAVINGS_PLAN","CLIENT_OPERATIONS"]},"execution_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution flow that the order processing goes through. If no value is specified, the default value is assumed - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRAIGHT_THROUGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STRAIGHT_THROUGH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCK -"},"children":[]}]}]}]}],"enum":["STRAIGHT_THROUGH","BLOCK"]},"executions":{"type":"array","description":"Order executions associated with this order","items":{"title":"Order execution","type":"object","properties":{"id":{"title":"Order execution unique identifier","type":"string","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"share_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"price":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,4})?$"},"transaction_time":{"type":"string","format":"date-time"},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL -"},"children":[]}]}]}]}],"default":"TOTAL","enum":["TOTAL"]},"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["type","amount"]}},"order_id":{"title":"Order unique identifier","type":"string","format":"uuid"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["FILLED","SETTLED","CANCELLED"]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"settlement_date":{"allOf":[{"title":"Settlement date","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order execution settlement date in the YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}]},"venue_id":{"type":"string","format":"uuid","description":"The ID of the venue"}},"required":["id","cash_amount","share_quantity","price","transaction_time","taxes","order_id","status","side","currency","venue_id"],"additionalProperties":false}},"client_reference":{"type":"string","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.","maxLength":100},"fee_configuration":{"type":"array","description":"fee configuration","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must be “ABSOLUTE”."},"children":[]}]}]}]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - US Dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["type","value_type","charge_method","cash_amount","currency"],"additionalProperties":false},{"title":"Transaction Fee Model","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"decision_maker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)"},"children":[]}]}]}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","side","instrument_id","instrument_id_type","order_type","quantity","status","fee","initiation_flow","executions"],"additionalProperties":false},{"type":"null"}]},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan Execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","SETTLED","CANCELLED"]},"type":{"type":"string","default":"PORTFOLIO","description":"The type of savings plan must be \"PORTFOLIO\"."},"execution_date":{"type":"string","description":"Date of a savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cancellation_reason":{"title":"Cancellation reason code for savings plan execution","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan execution was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan execution was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan execution was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"title":"Cancellation details for savings plan execution","description":"Human-readable description providing additional context about why the savings plan execution was cancelled.","type":"string"}},"required":["id","user_id","account_id","savings_plan_id","order_id","cash_amount","currency","status","type","execution_date","created_at","updated_at"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1038"},"schema_1039":{"kind":"json-schema","data":{"title":"Webhook - Savings Plan - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["SAVINGS_PLAN.CREATED","SAVINGS_PLAN.CANCELLED"]},"object":{"title":"Event savings plan request","anyOf":[{"title":"Savings plan (instrument)","type":"object","properties":{"id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Savings plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUMENT -"},"children":[]}]}]}]}],"enum":["PORTFOLIO","INSTRUMENT"]},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["ACTIVE","CANCELLED"]},"fee_configuration":{"title":"Savings plan fee configuration, only for instrument","type":"array","items":{"type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY"]},"transaction_fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}},"cancellation_reason":{"title":"Cancellation reason code for savings plan","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"description":"Additional details about the cancellation","type":"string"}},"required":["id","user_id","account_id","type","cash_amount","currency","start_date","period","interval","created_at","updated_at"],"additionalProperties":false},{"title":"Savings plan (portfolio)","type":"object","properties":{"id":{"title":"Savings plan unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"name":{"type":"string","description":"Savings plan name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Savings plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PORTFOLIO -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTRUMENT -"},"children":[]}]}]}]}],"enum":["PORTFOLIO","INSTRUMENT"]},"instrument_id":{"title":"Instrument unique identifier","description":"Instrument unique identifier.","oneOf":[{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"German securities identification code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German securities identification code known as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Wertpapierkennnummer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wertpapierkennnummer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-HJ-NP-Z0-9]{6}$"}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN - International Securities Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WKN - German securities identification code"},"children":[]}]}]}]}],"enum":["ISIN","WKN"],"default":"ISIN"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"start_date":{"type":"string","description":"First date of the savings plan execution in YYYY-MM-DD format.","pattern":"^[12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEK -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTH -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["WEEK","MONTH","YEAR"]},"interval":{"description":"Number of periods between executions","type":"integer","default":1,"minimum":1,"maximum":1000},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Savings Plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["ACTIVE","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for savings plan","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explains the reason why the savings plan was cancelled ."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT: The savings plan was cancelled by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST: The savings plan was cancelled by Upvest."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_CLIENT","CANCELLED_BY_UPVEST"]},"cancellation_details":{"description":"Additional details about the cancellation","type":"string"}},"required":["id","user_id","account_id","type","cash_amount","currency","start_date","period","interval","created_at","updated_at"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1039"},"schema_1040":{"kind":"json-schema","data":{"title":"Portfolios orders - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user who owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},{"type":"null"}]},"business_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the business that owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"type":"string","description":"Unique identifier for the business.","format":"uuid"},{"type":"null"}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED","SETTLED"]},"orders":{"type":"array","description":"Position liquidation orders associated with this account liquidation","items":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"default":"SELL"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"fee_collection_id":{"description":"Identifier of the fee collection associated with this liquidation. Null when no fee applies. See the Fees API to retrieve fee details.","oneOf":[{"type":"null"},{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","orders","fee_collection_id"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1040"},"schema_1041":{"kind":"json-schema","data":{"title":"Account liquidation - Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"}},"oneOf":[{"type":"object","required":["user_id"]},{"type":"object","required":["business_id"]}],"additionalProperties":false},"id":"schema_1041"},"schema_1042":{"kind":"json-schema","data":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user who owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},{"type":"null"}]},"business_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the business that owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"type":"string","description":"Unique identifier for the business.","format":"uuid"},{"type":"null"}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED","SETTLED"]},"orders":{"type":"array","description":"Position liquidation orders associated with this account liquidation","items":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"default":"SELL"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"fee_collection_id":{"description":"Identifier of the fee collection associated with this liquidation. Null when no fee applies. See the Fees API to retrieve fee details.","oneOf":[{"type":"null"},{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","orders","fee_collection_id"],"additionalProperties":false},"id":"schema_1042"},"schema_1043":{"kind":"json-schema","data":{"title":"Account liquidation unique identifier","type":"string","format":"uuid"},"id":"schema_1043"},"schema_1044":{"kind":"json-schema","data":{"title":"Webhook - Accounts - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT_LIQUIDATION.NEW","ACCOUNT_LIQUIDATION.PROCESSING","ACCOUNT_LIQUIDATION.FILLED","ACCOUNT_LIQUIDATION.CANCELLED","ACCOUNT_LIQUIDATION.SETTLED"]},"object":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation unique identifier","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user who owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},{"type":"null"}]},"business_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the business that owns the account. Exactly one of user_id or business_id will be set; the other will be null."},"children":[]}]}]}],"oneOf":[{"type":"string","description":"Unique identifier for the business.","format":"uuid"},{"type":"null"}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - British Pound"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED","SETTLED"]},"orders":{"type":"array","description":"Position liquidation orders associated with this account liquidation","items":{"title":"Account liquidation","type":"object","properties":{"id":{"title":"Account liquidation order unique identifier","type":"string","format":"uuid"},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"default":"SELL"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of the Account liquidation order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FILLED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED -"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","FILLED","CANCELLED"]}},"required":["id","side","status"],"additionalProperties":false}},"fee_collection_id":{"description":"Identifier of the fee collection associated with this liquidation. Null when no fee applies. See the Fees API to retrieve fee details.","oneOf":[{"type":"null"},{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}]}},"required":["id","created_at","updated_at","account_id","cash_amount","currency","status","orders","fee_collection_id"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1044"},"schema_1045":{"kind":"json-schema","data":{"type":"string","enum":["id","created_at"],"default":"created_at"},"id":"schema_1045"},"schema_1046":{"kind":"json-schema","data":{"title":"Payments - Direct Debits List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Direct debit funding request unique identifier","type":"string","description":"Direct debit funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated direct debits, this field will be absent.","deprecated":true},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"mandate_id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/direct_debit/direct_debit_submitting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the direct debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Direct debit is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Direct debit is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Direct debit was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Direct debit was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for direct debit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the direct debit was cancelled. The field is present in case the direct debit has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","mandate_id","cash_amount","currency"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1046"},"schema_1047":{"kind":"json-schema","data":{"title":"Payments - Direct Debit - Create - Request","type":"object","properties":{"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. This field is optional and will be removed in a future version.","deprecated":true},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"mandate_id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/direct_debit/direct_debit_submitting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["account_group_id","mandate_id","cash_amount"],"additionalProperties":false},"id":"schema_1047"},"schema_1048":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Direct debit funding request unique identifier","type":"string","description":"Direct debit funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated direct debits, this field will be absent.","deprecated":true},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"mandate_id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/direct_debit/direct_debit_submitting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the direct debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Direct debit is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Direct debit is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Direct debit was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Direct debit was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for direct debit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the direct debit was cancelled. The field is present in case the direct debit has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","mandate_id","cash_amount","currency"],"additionalProperties":false},"id":"schema_1048"},"schema_1049":{"kind":"json-schema","data":{"title":"Direct debit funding request unique identifier","type":"string","description":"Direct debit funding request unique identifier","format":"uuid"},"id":"schema_1049"},"schema_1050":{"kind":"json-schema","data":{"title":"Webhook - Direct Debits - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["DIRECT_DEBIT.NEW","DIRECT_DEBIT.PROCESSING","DIRECT_DEBIT.CONFIRMED","DIRECT_DEBIT.CANCELLED"]},"object":{"type":"object","properties":{"id":{"title":"Direct debit funding request unique identifier","type":"string","description":"Direct debit funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated direct debits, this field will be absent.","deprecated":true},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"mandate_id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/direct_debit/direct_debit_submitting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the direct debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Direct debit is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Direct debit is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Direct debit was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Direct debit was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for direct debit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the direct debit was cancelled. The field is present in case the direct debit has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","mandate_id","cash_amount","currency"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1050"},"schema_1051":{"kind":"json-schema","data":{"title":"Payments - Top ups List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Top up request unique identifier.","type":"string","description":"Top up request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"settlement_reference":{"type":"string","maxLength":130,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,130}$","description":"Settlement reference to be included in the corresponding bank transfer to settle this top up."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - The top up is created and confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - The top up is settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The top up is cancelled"},"children":[]}]}]}]}],"enum":["CONFIRMED","SETTLED","CANCELLED"]}},"required":["id","created_at","account_group_id","cash_amount","currency"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1051"},"schema_1052":{"kind":"json-schema","data":{"title":"Payments - Top up - Create - Request","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["account_group_id","cash_amount","currency"],"additionalProperties":false},"id":"schema_1052"},"schema_1053":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Top up request unique identifier.","type":"string","description":"Top up request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"settlement_reference":{"type":"string","maxLength":130,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,130}$","description":"Settlement reference to be included in the corresponding bank transfer to settle this top up."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - The top up is created and confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - The top up is settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The top up is cancelled"},"children":[]}]}]}]}],"enum":["CONFIRMED","SETTLED","CANCELLED"]}},"required":["id","created_at","account_group_id","cash_amount","currency"],"additionalProperties":false},"id":"schema_1053"},"schema_1054":{"kind":"json-schema","data":{"title":"Top up request unique identifier.","type":"string","description":"Top up request unique identifier.","format":"uuid"},"id":"schema_1054"},"schema_1055":{"kind":"json-schema","data":{"title":"Webhook - Top up - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["TOPUP.CONFIRMED","TOPUP.SETTLED","TOPUP.CANCELLED"]},"object":{"type":"object","properties":{"id":{"title":"Top up request unique identifier.","type":"string","description":"Top up request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"settlement_reference":{"type":"string","maxLength":130,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,130}$","description":"Settlement reference to be included in the corresponding bank transfer to settle this top up."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - The top up is created and confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - The top up is settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - The top up is cancelled"},"children":[]}]}]}]}],"enum":["CONFIRMED","SETTLED","CANCELLED"]}},"required":["id","created_at","account_group_id","cash_amount","currency"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1055"},"schema_1056":{"kind":"json-schema","data":{"title":"Payments - Withdrawal - Create - Request","type":"object","additionalProperties":false,"properties":{"reference_account_id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. This field is optional and will be removed in a future version.","deprecated":true},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash balance withdrawal guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["reference_account_id","account_group_id","amount"]},"id":"schema_1056"},"schema_1057":{"kind":"json-schema","data":{"title":"Payments - Withdrawal","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash withdrawal unique identifier","type":"string","description":"Cash withdrawal unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"reference_account_id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated withdrawals, this field will be absent.","deprecated":true},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash balance withdrawal guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total taxes"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"}},"required":["type","amount","currency"]}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Withdrawal is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Withdrawal is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Withdrawal was successfully sent to the bank for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Withdrawal was cancelled. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In rare instances, a bank may reject a withdrawal after it has been confirmed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal#potential-cancellation-after-confirmation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Potential cancellation after confirmation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the guide."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for withdrawal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the withdrawal was cancelled. The field is present in case the withdrawal has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","reference_account_id","account_group_id","amount","currency","created_at","updated_at","remittance_information"]},"id":"schema_1057"},"schema_1058":{"kind":"json-schema","data":{"title":"Cash withdrawal unique identifier","type":"string","description":"Cash withdrawal unique identifier","format":"uuid"},"id":"schema_1058"},"schema_1059":{"kind":"json-schema","data":{"title":"Withdrawals - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Payments - Withdrawal","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash withdrawal unique identifier","type":"string","description":"Cash withdrawal unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"reference_account_id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated withdrawals, this field will be absent.","deprecated":true},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash balance withdrawal guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total taxes"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"}},"required":["type","amount","currency"]}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Withdrawal is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Withdrawal is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Withdrawal was successfully sent to the bank for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Withdrawal was cancelled. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In rare instances, a bank may reject a withdrawal after it has been confirmed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal#potential-cancellation-after-confirmation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Potential cancellation after confirmation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the guide."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for withdrawal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the withdrawal was cancelled. The field is present in case the withdrawal has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","reference_account_id","account_group_id","amount","currency","created_at","updated_at","remittance_information"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1059"},"schema_1060":{"kind":"json-schema","data":{"title":"Webhook - Withdrawals - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["WITHDRAWAL.NEW","WITHDRAWAL.PROCESSING","WITHDRAWAL.CONFIRMED","WITHDRAWAL.CANCELLED"]},"object":{"title":"Payments - Withdrawal","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash withdrawal unique identifier","type":"string","description":"Cash withdrawal unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"reference_account_id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"user_id":{"allOf":[{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"}],"description":"The ID of the user. For business-initiated withdrawals, this field will be absent.","deprecated":true},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,';_ ]{0,140}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash balance withdrawal guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"taxes":{"type":"array","items":{"title":"Tax","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total taxes"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"}},"required":["type","amount","currency"]}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Withdrawal is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Withdrawal is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Withdrawal was successfully sent to the bank for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Withdrawal was cancelled. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In rare instances, a bank may reject a withdrawal after it has been confirmed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/documentation/guides/payments/cash_balances/cash_withdrawal#potential-cancellation-after-confirmation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Potential cancellation after confirmation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the guide."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","CONFIRMED","CANCELLED"]},"cancellation_reason":{"title":"Cancellation reason code for withdrawal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the withdrawal was cancelled. The field is present in case the withdrawal has a status of CANCELLED."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_BY_CLIENT - The payment was cancelled at your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER - Reason not available (applies to historical data only)."},"children":[]}]}]}]}],"type":"string","enum":["CANCELLED_BY_BANK","CANCELLED_BY_UPVEST","CANCELLED_BY_CLIENT","OTHER"]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","reference_account_id","account_group_id","amount","currency","created_at","updated_at","remittance_information"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1060"},"schema_1061":{"kind":"json-schema","data":{"title":"Cash Balance Transfers - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Payments - Cash Balance Transfer","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the cash balance transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Transfer has been created and the cash movement is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Cash was successfully moved from the source to the target account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Transfer was cancelled and no cash was moved."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]},"cancellation_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the transfer was cancelled. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","source_account_group_id","target_account_group_id","amount","currency","status","created_at","updated_at"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1061"},"schema_1062":{"kind":"json-schema","data":{"title":"Payments - Cash Balance Transfer - Create - Request","type":"object","additionalProperties":false,"properties":{"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["source_account_group_id","target_account_group_id","amount","currency"]},"id":"schema_1062"},"schema_1063":{"kind":"json-schema","data":{"title":"Payments - Cash Balance Transfer","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the cash balance transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Transfer has been created and the cash movement is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Cash was successfully moved from the source to the target account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Transfer was cancelled and no cash was moved."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]},"cancellation_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the transfer was cancelled. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","source_account_group_id","target_account_group_id","amount","currency","status","created_at","updated_at"]},"id":"schema_1063"},"schema_1064":{"kind":"json-schema","data":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"id":"schema_1064"},"schema_1065":{"kind":"json-schema","data":{"title":"User Cash Balance Transfers - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Payments - Cash Balance Transfer","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the cash balance transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Transfer has been created and the cash movement is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Cash was successfully moved from the source to the target account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Transfer was cancelled and no cash was moved."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]},"cancellation_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the transfer was cancelled. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","source_account_group_id","target_account_group_id","amount","currency","status","created_at","updated_at"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1065"},"schema_1066":{"kind":"json-schema","data":{"title":"Business Cash Balance Transfers - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Payments - Cash Balance Transfer","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the cash balance transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Transfer has been created and the cash movement is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Cash was successfully moved from the source to the target account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Transfer was cancelled and no cash was moved."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]},"cancellation_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the transfer was cancelled. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","source_account_group_id","target_account_group_id","amount","currency","status","created_at","updated_at"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1066"},"schema_1067":{"kind":"json-schema","data":{"title":"Webhook - Cash Balance Transfer - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["CASH_BALANCE_TRANSFER.ISSUED","CASH_BALANCE_TRANSFER.CONFIRMED","CASH_BALANCE_TRANSFER.CANCELLED"]},"object":{"title":"Payments - Cash Balance Transfer","type":"object","additionalProperties":false,"properties":{"id":{"title":"Cash balance transfer unique identifier","type":"string","description":"Cash balance transfer unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"source_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred from. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"target_account_group_id":{"allOf":[{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account group the cash is transferred to. Must differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_account_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and belong to the same user and tenant. Allowed account group types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHILD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the source and target account groups must be of the same type."},"children":[]}]}]}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the cash balance transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Transfer has been created and the cash movement is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Cash was successfully moved from the source to the target account group."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Transfer was cancelled and no cash was moved."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]},"cancellation_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the transfer was cancelled. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","source_account_group_id","target_account_group_id","amount","currency","status","created_at","updated_at"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1067"},"schema_1068":{"kind":"json-schema","data":{"title":"Users - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Reference Account","type":"object","properties":{"id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_owner":{"type":"string","maxLength":140,"description":"Name of the reference account holder"},"name":{"type":"string","maxLength":100,"description":"Human-readable name of the reference bank account"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the reference account"}},"required":["id","created_at","updated_at","account_owner","name","iban","bic","confirmed_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1068"},"schema_1069":{"kind":"json-schema","data":{"title":"Reference Account - Create - Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_owner":{"type":"string","maxLength":140,"description":"Name of the reference account holder"},"name":{"type":"string","maxLength":100,"description":"Human-readable name of the reference bank account"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the reference account"}},"required":["account_owner","iban","bic","confirmed_at"],"additionalProperties":false},"id":"schema_1069"},"schema_1070":{"kind":"json-schema","data":{"title":"Reference Account","type":"object","properties":{"id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_owner":{"type":"string","maxLength":140,"description":"Name of the reference account holder"},"name":{"type":"string","maxLength":100,"description":"Human-readable name of the reference bank account"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the reference account"}},"required":["id","created_at","updated_at","account_owner","name","iban","bic","confirmed_at"],"additionalProperties":false},"id":"schema_1070"},"schema_1071":{"kind":"json-schema","data":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"id":"schema_1071"},"schema_1072":{"kind":"json-schema","data":{"title":"Business Reference Accounts - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Business Reference Account","type":"object","properties":{"id":{"title":"Reference account unique identifier.","type":"string","description":"Reference account unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"account_owner":{"type":"string","maxLength":140,"description":"Name of the reference account holder"},"name":{"type":"string","maxLength":100,"description":"Human-readable name of the reference bank account"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the reference account"}},"required":["id","created_at","updated_at","account_owner","iban","bic","confirmed_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1072"},"schema_1073":{"kind":"json-schema","data":{"title":"Mandates - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Direct Debit Mandate","type":"object","properties":{"id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"creditor_name":{"type":"string","maxLength":100,"description":"Name of the creditor on the mandate."},"creditor_id":{"type":"string","maxLength":20,"description":"Banking identifier of the creditor."},"creditor_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"type":{"type":"string","maxLength":10,"enum":["RECURRENT"],"default":"RECURRENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECURRENT -"},"children":[]}]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the mandate"}},"required":["id","created_at","iban","bic","creditor_name","creditor_id","creditor_address","type","confirmed_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1073"},"schema_1074":{"kind":"json-schema","data":{"title":"Mandates - List (Business) - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Direct Debit Mandate","type":"object","properties":{"id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"creditor_name":{"type":"string","maxLength":100,"description":"Name of the creditor on the mandate."},"creditor_id":{"type":"string","maxLength":20,"description":"Banking identifier of the creditor."},"creditor_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"type":{"type":"string","maxLength":10,"enum":["RECURRENT"],"default":"RECURRENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECURRENT -"},"children":[]}]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the mandate"}},"required":["id","created_at","iban","bic","creditor_name","creditor_id","creditor_address","type","confirmed_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1074"},"schema_1075":{"kind":"json-schema","data":{"title":"Mandate - Create - Request","type":"object","properties":{"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the mandate"}},"required":["iban","bic","confirmed_at"],"additionalProperties":false},"id":"schema_1075"},"schema_1076":{"kind":"json-schema","data":{"title":"Direct Debit Mandate","type":"object","properties":{"id":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obfuscated International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\\*{10}[A-Z0-9]{4}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"creditor_name":{"type":"string","maxLength":100,"description":"Name of the creditor on the mandate."},"creditor_id":{"type":"string","maxLength":20,"description":"Banking identifier of the creditor."},"creditor_address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]},"type":{"type":"string","maxLength":10,"enum":["RECURRENT"],"default":"RECURRENT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of mandate."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECURRENT -"},"children":[]}]}]}]}]},"confirmed_at":{"type":"string","format":"date-time","description":"Timestamp of when user validated the mandate"}},"required":["id","created_at","iban","bic","creditor_name","creditor_id","creditor_address","type","confirmed_at"],"additionalProperties":false},"id":"schema_1076"},"schema_1077":{"kind":"json-schema","data":{"title":"Direct Debit Mandate unique identifier.","type":"string","description":"Direct Debit Mandate unique identifier.","format":"uuid"},"id":"schema_1077"},"schema_1078":{"kind":"json-schema","data":{"title":"Payments - Virtual Bank Accounts List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"name":{"type":"string","description":"Name of the virtual bank account"},"owner":{"type":"object","description":"Owner of the virtual bank account","properties":{"name":{"type":"string","description":"Name of the owner of the virtual bank account"}},"required":["name"],"additionalProperties":false},"identification":{"type":"object","description":"Identification details","properties":{"swift":{"type":"object","description":"SWIFT details","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"required":["iban","bic"],"additionalProperties":false}},"additionalProperties":false}},"required":["id","created_at","account_group_id","owner","identification"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1078"},"schema_1079":{"kind":"json-schema","data":{"title":"Payments - Virtual Bank Account - Create - Request","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"name":{"type":"string","description":"Name of the virtual bank account"}},"required":["account_group_id","name"],"additionalProperties":false},"id":"schema_1079"},"schema_1080":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"name":{"type":"string","description":"Name of the virtual bank account"},"owner":{"type":"object","description":"Owner of the virtual bank account","properties":{"name":{"type":"string","description":"Name of the owner of the virtual bank account"}},"required":["name"],"additionalProperties":false},"identification":{"type":"object","description":"Identification details","properties":{"swift":{"type":"object","description":"SWIFT details","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"required":["iban","bic"],"additionalProperties":false}},"additionalProperties":false}},"required":["id","created_at","account_group_id","owner","identification"],"additionalProperties":false},"id":"schema_1080"},"schema_1081":{"kind":"json-schema","data":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"id":"schema_1081"},"schema_1082":{"kind":"json-schema","data":{"title":"Webhook - Virtual Bank Account - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["VIRTUAL_BANK_ACCOUNT.CREATED"]},"object":{"type":"object","properties":{"id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"name":{"type":"string","description":"Name of the virtual bank account"},"owner":{"type":"object","description":"Owner of the virtual bank account","properties":{"name":{"type":"string","description":"Name of the owner of the virtual bank account"}},"required":["name"],"additionalProperties":false},"identification":{"type":"object","description":"Identification details","properties":{"swift":{"type":"object","description":"SWIFT details","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"required":["iban","bic"],"additionalProperties":false}},"additionalProperties":false}},"required":["id","created_at","account_group_id","owner","identification"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1082"},"schema_1083":{"kind":"json-schema","data":{"type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"virtual_bank_account_id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"name":{"type":"string","description":"Name of the recipient account for the SEPA Credit Transfer"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"owner":{"type":"object","description":"Owner of the virtual bank account","properties":{"name":{"type":"string","description":"Name of the owner of the virtual bank account"}},"required":["name"],"additionalProperties":false},"identification":{"type":"object","description":"Identification details","properties":{"swift":{"type":"object","description":"SWIFT details","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"},"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"required":["iban","bic"],"additionalProperties":false}},"additionalProperties":false},"remittance_information":{"type":"string","description":"Payment reference the one that should be used for SEPA Credit Transfer"}},"required":["currency","owner","identification"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1083"},"schema_1084":{"kind":"json-schema","data":{"title":"Payments - Credit Fundings List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Credit Funding request unique identifier","type":"string","description":"Credit Funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the credit funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Credit Funding was confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Credit Funding was cancelled."},"children":[]}]}]}]}],"enum":["CONFIRMED","CANCELLED"]},"remittance_information":{"type":"string","description":"Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer"},"counterparty":{"type":"object","properties":{"identification":{"type":"object","properties":{"name":{"type":"string","description":"Name of the counterparty"}},"required":["name"]},"account":{"type":"object","properties":{"identification":{"type":"object","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"}},"required":["iban"]}},"required":["identification"]}},"required":["identification","account"]},"virtual_bank_account_id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","cash_amount","currency","remittance_information","counterparty"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1084"},"schema_1085":{"kind":"json-schema","data":{"title":"Credit Funding request unique identifier","type":"string","description":"Credit Funding request unique identifier","format":"uuid"},"id":"schema_1085"},"schema_1086":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Credit Funding request unique identifier","type":"string","description":"Credit Funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the credit funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Credit Funding was confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Credit Funding was cancelled."},"children":[]}]}]}]}],"enum":["CONFIRMED","CANCELLED"]},"remittance_information":{"type":"string","description":"Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer"},"counterparty":{"type":"object","properties":{"identification":{"type":"object","properties":{"name":{"type":"string","description":"Name of the counterparty"}},"required":["name"]},"account":{"type":"object","properties":{"identification":{"type":"object","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"}},"required":["iban"]}},"required":["identification"]}},"required":["identification","account"]},"virtual_bank_account_id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","cash_amount","currency","remittance_information","counterparty"],"additionalProperties":false},"id":"schema_1086"},"schema_1087":{"kind":"json-schema","data":{"title":"Webhook - Credit Funding - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["CREDIT_FUNDING.CONFIRMED","CREDIT_FUNDING.CANCELLED"],"default":"CREDIT_FUNDING.CONFIRMED"},"object":{"type":"object","properties":{"id":{"title":"Credit Funding request unique identifier","type":"string","description":"Credit Funding request unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the credit funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Credit Funding was confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Credit Funding was cancelled."},"children":[]}]}]}]}],"enum":["CONFIRMED","CANCELLED"]},"remittance_information":{"type":"string","description":"Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer"},"counterparty":{"type":"object","properties":{"identification":{"type":"object","properties":{"name":{"type":"string","description":"Name of the counterparty"}},"required":["name"]},"account":{"type":"object","properties":{"identification":{"type":"object","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"}},"required":["iban"]}},"required":["identification"]}},"required":["identification","account"]},"virtual_bank_account_id":{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["id","created_at","account_group_id","cash_amount","currency","remittance_information","counterparty"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1087"},"schema_1088":{"kind":"json-schema","data":{"title":"Cash Balances - Retrieve - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"balance":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_withdrawal":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_group_id","currency","balance","locked_for_trading","pending_settlement","available_for_withdrawal","available_for_trading"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1088"},"schema_1089":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"id":"schema_1089"},"schema_1090":{"kind":"json-schema","data":{"type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"balance":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_withdrawal":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_group_id","currency","balance","locked_for_trading","pending_settlement","available_for_withdrawal","available_for_trading"],"additionalProperties":false},"id":"schema_1090"},"schema_1091":{"kind":"json-schema","data":{"title":"Webhook - Positions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["CASH_BALANCE.UPDATED"],"default":"CASH_BALANCE.UPDATED"},"object":{"type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"balance":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_withdrawal":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_group_id","currency","balance","locked_for_trading","pending_settlement","available_for_withdrawal","available_for_trading"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1091"},"schema_1092":{"kind":"json-schema","data":{"title":"Positions - List - Response","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"instrument":{"type":"object","properties":{"uuid":{"type":"string","description":"Instrument unique identifier.","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_instruction":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"settled_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_id","instrument","quantity","locked_for_trading","pending_settlement","available_for_trading","available_for_instruction","settled_quantity"],"additionalProperties":false}},"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]}},"required":["data","meta"],"additionalProperties":false},"id":"schema_1092"},"schema_1093":{"kind":"json-schema","data":{"type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"instrument":{"type":"object","properties":{"uuid":{"type":"string","description":"Instrument unique identifier.","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_instruction":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"settled_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_id","instrument","quantity","locked_for_trading","pending_settlement","available_for_trading","available_for_instruction","settled_quantity"],"additionalProperties":false},"id":"schema_1093"},"schema_1094":{"kind":"json-schema","data":{"title":"Webhook - Positions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["POSITION.UPDATED"],"default":"POSITION.UPDATED"},"object":{"type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"instrument":{"type":"object","properties":{"uuid":{"type":"string","description":"Instrument unique identifier.","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"locked_for_trading":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"pending_settlement":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_trading":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"available_for_instruction":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"settled_quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["account_id","instrument","quantity","locked_for_trading","pending_settlement","available_for_trading","available_for_instruction","settled_quantity"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1094"},"schema_1095":{"kind":"json-schema","data":{"type":"string","enum":["EOD","HIGHEST_AVAILABLE"],"description":"Defines the quality of the price used in the valuation."},"id":"schema_1095"},"schema_1096":{"kind":"json-schema","data":{"title":"Account Valuation","type":"object","properties":{"id":{"title":"Account valuation unique identifier","description":"Account valuation unique identifier.","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"total_security_value":{"title":"Total security value","description":"Entity representing the monetary value by amount and currency.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"],"additionalProperties":false},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested price quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - End of day prices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HIGHEST_AVAILABLE - The most recent available prices"},"children":[]}]}]}]}],"enum":["EOD","HIGHEST_AVAILABLE"]},"security_positions":{"type":"array","description":"Positions associated with this account valuation.","items":{"title":"Account valuation security position","type":"object","properties":{"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"String representing the instrument internal identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"description":"Total quantity of the instrument (10 decimal places)."}]},"value":{"nullable":true,"allOf":[{"title":"Security position value","description":"Entity representing the monetary value by amount and currency, and the time of the price used.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"price_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the price used for the calculation. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["amount","currency","price_time"],"additionalProperties":false},{"nullable":true}]},"weight":{"description":"Total weight of the instrument (10 decimal places).","oneOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"type":"null"}]},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price quality used for the calculation of the value of the position."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - end of day price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALTIME - realtime price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELAYED - delayed price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA - no available price"},"children":[]}]}]}]}],"enum":["EOD","REALTIME","DELAYED","NA"]}},"required":["instrument","quantity","value","weight"],"additionalProperties":false}},"valuation_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time as of which the value was calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["id","account_id","created_at","updated_at","valuation_time","total_security_value","price_quality","security_positions"],"additionalProperties":false},"id":"schema_1096"},"schema_1097":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns account valuations starting from and including this date (UTC)"},"id":"schema_1097"},"schema_1098":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns account valuations up until this date (UTC)"},"id":"schema_1098"},"schema_1099":{"kind":"json-schema","data":{"type":"string","enum":["valuation_time"],"default":"valuation_time"},"id":"schema_1099"},"schema_1100":{"kind":"json-schema","data":{"title":"Account Valuation - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Account Valuation","type":"object","properties":{"id":{"title":"Account valuation unique identifier","description":"Account valuation unique identifier.","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"total_security_value":{"title":"Total security value","description":"Entity representing the monetary value by amount and currency.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"],"additionalProperties":false},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested price quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - End of day prices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HIGHEST_AVAILABLE - The most recent available prices"},"children":[]}]}]}]}],"enum":["EOD","HIGHEST_AVAILABLE"]},"security_positions":{"type":"array","description":"Positions associated with this account valuation.","items":{"title":"Account valuation security position","type":"object","properties":{"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"String representing the instrument internal identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"description":"Total quantity of the instrument (10 decimal places)."}]},"value":{"nullable":true,"allOf":[{"title":"Security position value","description":"Entity representing the monetary value by amount and currency, and the time of the price used.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"price_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the price used for the calculation. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["amount","currency","price_time"],"additionalProperties":false},{"nullable":true}]},"weight":{"description":"Total weight of the instrument (10 decimal places).","oneOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"type":"null"}]},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price quality used for the calculation of the value of the position."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - end of day price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALTIME - realtime price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELAYED - delayed price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA - no available price"},"children":[]}]}]}]}],"enum":["EOD","REALTIME","DELAYED","NA"]}},"required":["instrument","quantity","value","weight"],"additionalProperties":false}},"valuation_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time as of which the value was calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["id","account_id","created_at","updated_at","valuation_time","total_security_value","price_quality","security_positions"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1100"},"schema_1101":{"kind":"json-schema","data":{"title":"Webhook - Account Valuation - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT_VALUATION.CREATED"]},"object":{"title":"Account Valuation","type":"object","properties":{"id":{"title":"Account valuation unique identifier","description":"Account valuation unique identifier.","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"total_security_value":{"title":"Total security value","description":"Entity representing the monetary value by amount and currency.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"],"additionalProperties":false},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested price quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - End of day prices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HIGHEST_AVAILABLE - The most recent available prices"},"children":[]}]}]}]}],"enum":["EOD","HIGHEST_AVAILABLE"]},"security_positions":{"type":"array","description":"Positions associated with this account valuation.","items":{"title":"Account valuation security position","type":"object","properties":{"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"String representing the instrument internal identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"description":"Total quantity of the instrument (10 decimal places)."}]},"value":{"nullable":true,"allOf":[{"title":"Security position value","description":"Entity representing the monetary value by amount and currency, and the time of the price used.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"price_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the price used for the calculation. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["amount","currency","price_time"],"additionalProperties":false},{"nullable":true}]},"weight":{"description":"Total weight of the instrument (10 decimal places).","oneOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"type":"null"}]},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price quality used for the calculation of the value of the position."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - end of day price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALTIME - realtime price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELAYED - delayed price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA - no available price"},"children":[]}]}]}]}],"enum":["EOD","REALTIME","DELAYED","NA"]}},"required":["instrument","quantity","value","weight"],"additionalProperties":false}},"valuation_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time as of which the value was calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["id","account_id","created_at","updated_at","valuation_time","total_security_value","price_quality","security_positions"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1101"},"schema_1102":{"kind":"json-schema","data":{"title":"Webhook - Intraday Account Valuation - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["INTRADAY_ACCOUNT_VALUATION.CREATED"]},"object":{"title":"Account Valuation","type":"object","properties":{"id":{"title":"Account valuation unique identifier","description":"Account valuation unique identifier.","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"total_security_value":{"title":"Total security value","description":"Entity representing the monetary value by amount and currency.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["amount","currency"],"additionalProperties":false},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested price quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - End of day prices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HIGHEST_AVAILABLE - The most recent available prices"},"children":[]}]}]}]}],"enum":["EOD","HIGHEST_AVAILABLE"]},"security_positions":{"type":"array","description":"Positions associated with this account valuation.","items":{"title":"Account valuation security position","type":"object","properties":{"instrument":{"title":"Instrument","description":"Entity representing the financial instrument.","type":"object","properties":{"uuid":{"description":"String representing the instrument internal identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"quantity":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"description":"Total quantity of the instrument (10 decimal places)."}]},"value":{"nullable":true,"allOf":[{"title":"Security position value","description":"Entity representing the monetary value by amount and currency, and the time of the price used.","type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"price_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the price used for the calculation. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["amount","currency","price_time"],"additionalProperties":false},{"nullable":true}]},"weight":{"description":"Total weight of the instrument (10 decimal places).","oneOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,10})?$"},{"type":"null"}]},"price_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price quality used for the calculation of the value of the position."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD - end of day price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALTIME - realtime price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELAYED - delayed price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA - no available price"},"children":[]}]}]}]}],"enum":["EOD","REALTIME","DELAYED","NA"]}},"required":["instrument","quantity","value","weight"],"additionalProperties":false}},"valuation_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time as of which the value was calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]}},"required":["id","account_id","created_at","updated_at","valuation_time","total_security_value","price_quality","security_positions"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1102"},"schema_1103":{"kind":"json-schema","data":{"type":"string","enum":["date"],"default":"date"},"id":"schema_1103"},"schema_1104":{"kind":"json-schema","data":{"title":"Account Return - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Account Returns","type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when returns were calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"twr":{"title":"","type":"object","properties":{"daily":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cumulative":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cumulative_start_date":{"type":"string","format":"date-time","description":"Date when the cumulative time-weighted returns calculation starts."}}}},"required":["account_id","date","twr"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1104"},"schema_1105":{"kind":"json-schema","data":{"title":"Webhook - Account Returns - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT_RETURNS.CREATED"],"default":"ACCOUNT_RETURNS.CREATED"},"object":{"title":"Account Returns","type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when returns were calculated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"twr":{"title":"","type":"object","properties":{"daily":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cumulative":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},"cumulative_start_date":{"type":"string","format":"date-time","description":"Date when the cumulative time-weighted returns calculation starts."}}}},"required":["account_id","date","twr"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1105"},"schema_1106":{"kind":"json-schema","data":{"title":"Virtual Cash Balance - Virtual Cash Increase - Create - Request","type":"object","additionalProperties":false,"properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["account_group_id","amount","currency"]},"id":"schema_1106"},"schema_1107":{"kind":"json-schema","data":{"title":"Virtual Cash Balance - Virtual Cash Increase","type":"object","additionalProperties":false,"properties":{"id":{"title":"Virtual cash unique identifier","type":"string","description":"Virtual cash unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the virtual cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Virtual cash increase is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Virtual cash increase was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Virtual cash increase was cancelled."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]}},"required":["id","account_group_id","amount","currency","status","created_at","updated_at"]},"id":"schema_1107"},"schema_1108":{"kind":"json-schema","data":{"title":"Virtual Cash Balance - Virtual Cash Decrease - Create - Request","type":"object","additionalProperties":false,"properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["account_group_id","amount","currency"]},"id":"schema_1108"},"schema_1109":{"kind":"json-schema","data":{"title":"Virtual Cash Balance - Virtual Cash Decrease","type":"object","additionalProperties":false,"properties":{"id":{"title":"Virtual cash unique identifier","type":"string","description":"Virtual cash unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the virtual cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Virtual cash decrease is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Virtual cash decrease was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUEUED - Virtual cash decrease was queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Virtual cash decrease was cancelled."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","QUEUED","CANCELLED"]}},"required":["id","account_group_id","amount","currency","status","created_at","updated_at"]},"id":"schema_1109"},"schema_1110":{"kind":"json-schema","data":{"title":"Virtual cash unique identifier","type":"string","description":"Virtual cash unique identifier","format":"uuid"},"id":"schema_1110"},"schema_1111":{"kind":"json-schema","data":{"title":"Webhook - Virtual Cash Balance - Virtual Cash Increase - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["VIRTUAL_CASH_INCREASE.ISSUED","VIRTUAL_CASH_INCREASE.CONFIRMED","VIRTUAL_CASH_INCREASE.CANCELLED"]},"object":{"title":"Virtual Cash Balance - Virtual Cash Increase","type":"object","additionalProperties":false,"properties":{"id":{"title":"Virtual cash unique identifier","type":"string","description":"Virtual cash unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the virtual cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Virtual cash increase is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Virtual cash increase was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Virtual cash increase was cancelled."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","CANCELLED"]}},"required":["id","account_group_id","amount","currency","status","created_at","updated_at"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1111"},"schema_1112":{"kind":"json-schema","data":{"title":"Webhook - Virtual Cash Balance - Virtual Cash Decrease - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["VIRTUAL_CASH_DECREASE.ISSUED","VIRTUAL_CASH_DECREASE.CONFIRMED","VIRTUAL_CASH_DECREASE.QUEUED","VIRTUAL_CASH_DECREASE.CANCELLED"]},"object":{"title":"Virtual Cash Balance - Virtual Cash Decrease","type":"object","additionalProperties":false,"properties":{"id":{"title":"Virtual cash unique identifier","type":"string","description":"Virtual cash unique identifier","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the virtual cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISSUED - Virtual cash decrease is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - Virtual cash decrease was successfully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUEUED - Virtual cash decrease was queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Virtual cash decrease was cancelled."},"children":[]}]}]}]}],"enum":["ISSUED","CONFIRMED","QUEUED","CANCELLED"]}},"required":["id","account_group_id","amount","currency","status","created_at","updated_at"]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1112"},"schema_1113":{"kind":"json-schema","data":{"title":"Fee Collection - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Fee Collection","type":"object","properties":{"id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation"},"children":[]}]}]}]}],"enum":["SERVICE_FEE","SERVICE_FEE_LIQUIDATION"]},"collection_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"processed_amount":{"type":"object","properties":{"cash_balance":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"sell_to_cover":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"total_residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}}},"sell_to_cover_orders":{"type":"array","items":{"title":"Sell to cover order details","type":"object","properties":{"id":{"title":"Sell to cover order id used to cover fee amount.","type":"string","description":"Sell to cover order id used to cover fee amount.","format":"uuid"},"residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["id","residual_amount"],"additionalProperties":false}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Fee collection is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINALISED - Fees have been collected from the account and the funds has been transferred to the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Fee collection has been cancelled."},"children":[]}]}]}]}],"enum":["PROCESSING","FINALISED","CANCELLED"]},"period_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"period_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"calculation_breakdown":{"type":"array","description":"Breakdown of the fee collection by fee model and subperiod. Populated only for fee collections created from daily fee model calculations.","items":{"title":"Fee Calculation Breakdown Item","type":"object","properties":{"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"subperiod_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subperiod_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subtotal_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"components":{"type":"array","description":"Individual fee components contributing to the subtotal.","items":{"title":"Fee Breakdown Component","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee component"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_LUMP_SUM - Lump sum transaction fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLATFORM - Platform fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE - Service fee (client portfolio)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT - Value-added tax"},"children":[]}]}]}]}],"enum":["TRANSACTION_LUMP_SUM","PLATFORM","SERVICE","VAT"]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["type","amount"],"additionalProperties":false}}},"required":["fee_model_id","subperiod_start","subperiod_end","subtotal_amount","components"],"additionalProperties":false}},"replaced_collection_id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}},"required":["id","account_id","account_group_id","type","collection_amount","processed_amount","currency","status","period_start","period_end","created_at","updated_at"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1113"},"schema_1114":{"kind":"json-schema","data":{"title":"Fee Collection - Create - Request","type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation"},"children":[]}]}]}]}],"enum":["SERVICE_FEE","SERVICE_FEE_LIQUIDATION"]},"collection_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"period_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"period_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]}},"required":["account_id","type","collection_amount","currency","period_start","period_end"],"additionalProperties":false},"id":"schema_1114"},"schema_1115":{"kind":"json-schema","data":{"title":"Fee Collection","type":"object","properties":{"id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation"},"children":[]}]}]}]}],"enum":["SERVICE_FEE","SERVICE_FEE_LIQUIDATION"]},"collection_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"processed_amount":{"type":"object","properties":{"cash_balance":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"sell_to_cover":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"total_residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}}},"sell_to_cover_orders":{"type":"array","items":{"title":"Sell to cover order details","type":"object","properties":{"id":{"title":"Sell to cover order id used to cover fee amount.","type":"string","description":"Sell to cover order id used to cover fee amount.","format":"uuid"},"residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["id","residual_amount"],"additionalProperties":false}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Fee collection is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINALISED - Fees have been collected from the account and the funds has been transferred to the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Fee collection has been cancelled."},"children":[]}]}]}]}],"enum":["PROCESSING","FINALISED","CANCELLED"]},"period_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"period_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"calculation_breakdown":{"type":"array","description":"Breakdown of the fee collection by fee model and subperiod. Populated only for fee collections created from daily fee model calculations.","items":{"title":"Fee Calculation Breakdown Item","type":"object","properties":{"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"subperiod_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subperiod_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subtotal_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"components":{"type":"array","description":"Individual fee components contributing to the subtotal.","items":{"title":"Fee Breakdown Component","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee component"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_LUMP_SUM - Lump sum transaction fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLATFORM - Platform fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE - Service fee (client portfolio)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT - Value-added tax"},"children":[]}]}]}]}],"enum":["TRANSACTION_LUMP_SUM","PLATFORM","SERVICE","VAT"]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["type","amount"],"additionalProperties":false}}},"required":["fee_model_id","subperiod_start","subperiod_end","subtotal_amount","components"],"additionalProperties":false}},"replaced_collection_id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}},"required":["id","account_id","account_group_id","type","collection_amount","processed_amount","currency","status","period_start","period_end","created_at","updated_at"],"additionalProperties":false},"id":"schema_1115"},"schema_1116":{"kind":"json-schema","data":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"},"id":"schema_1116"},"schema_1117":{"kind":"json-schema","data":{"title":"Webhook - Fee Collection - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["FEE_COLLECTION.CREATED","FEE_COLLECTION.FINALISED","FEE_COLLECTION.CANCELLED"]},"object":{"title":"Fee Collection","type":"object","properties":{"id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation"},"children":[]}]}]}]}],"enum":["SERVICE_FEE","SERVICE_FEE_LIQUIDATION"]},"collection_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"processed_amount":{"type":"object","properties":{"cash_balance":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"sell_to_cover":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"total_residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}}},"sell_to_cover_orders":{"type":"array","items":{"title":"Sell to cover order details","type":"object","properties":{"id":{"title":"Sell to cover order id used to cover fee amount.","type":"string","description":"Sell to cover order id used to cover fee amount.","format":"uuid"},"residual_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["id","residual_amount"],"additionalProperties":false}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Fee collection is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINALISED - Fees have been collected from the account and the funds has been transferred to the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Fee collection has been cancelled."},"children":[]}]}]}]}],"enum":["PROCESSING","FINALISED","CANCELLED"]},"period_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"period_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee collection period in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"calculation_breakdown":{"type":"array","description":"Breakdown of the fee collection by fee model and subperiod. Populated only for fee collections created from daily fee model calculations.","items":{"title":"Fee Calculation Breakdown Item","type":"object","properties":{"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"subperiod_start":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subperiod_end":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the fee subperiod in YYYY-MM-DD format. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339, section 5.6"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 3339"},"children":[]}]}]}]},"subtotal_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"components":{"type":"array","description":"Individual fee components contributing to the subtotal.","items":{"title":"Fee Breakdown Component","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee component"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_LUMP_SUM - Lump sum transaction fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLATFORM - Platform fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE - Service fee (client portfolio)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT - Value-added tax"},"children":[]}]}]}]}],"enum":["TRANSACTION_LUMP_SUM","PLATFORM","SERVICE","VAT"]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"}},"required":["type","amount"],"additionalProperties":false}}},"required":["fee_model_id","subperiod_start","subperiod_end","subtotal_amount","components"],"additionalProperties":false}},"replaced_collection_id":{"title":"Fee collection unique identifier.","type":"string","description":"Fee collection unique identifier.","format":"uuid"}},"required":["id","account_id","account_group_id","type","collection_amount","processed_amount","currency","status","period_start","period_end","created_at","updated_at"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1117"},"schema_1118":{"kind":"json-schema","data":{"title":"Fee configuration - Create - Request","type":"object","properties":{"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["account_id","fee_model_id"],"additionalProperties":false},"id":"schema_1118"},"schema_1119":{"kind":"json-schema","data":{"title":"Fee Configuration","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["account_id","fee_model_id","created_at","updated_at"],"additionalProperties":false},"id":"schema_1119"},"schema_1120":{"kind":"json-schema","data":{"title":"Fee configuration - Update - Request","type":"object","properties":{"fee_model_id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"}},"required":["fee_model_id"],"additionalProperties":false},"id":"schema_1120"},"schema_1121":{"kind":"json-schema","data":{"title":"Transaction Fee Models - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Fee Configuration","type":"object","properties":{"id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"label":{"title":"Label","description":"A human-readable label for the transaction fee model.","type":"string"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT"]},"value_type":{"title":"Value Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ABSOLUTE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RELATIVE -"},"children":[]}]}]}]}],"enum":["ABSOLUTE","RELATIVE"]},"application_type":{"title":"Application Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VOLUME -"},"children":[]}]}]}]}],"enum":["VOLUME"]},"base_amount_scope":{"title":"Base Amount Scope","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base amount scope of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER -"},"children":[]}]}]}]}],"enum":["ORDER"]},"tiers":{"description":"The tiers of the transaction fee model.","type":"array","items":{"title":"Fee Tier","oneOf":[{"title":"Absolute Transaction Fee Tier","description":"A single tier of a transaction fee model with a fixed, absolute cash amount.","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_amount"]},{"title":"Relative Transaction Fee Tier","description":"A single tier of a transaction fee model based on a percentage (defined in basis points).","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_bps":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"min_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"max_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_bps"]}]}}},"required":["id","created_at","updated_at","label","currency","charge_method","value_type","application_type","base_amount_scope","tiers"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1121"},"schema_1122":{"kind":"json-schema","data":{"title":"Fee configuration - Create - Request","type":"object","properties":{"label":{"title":"Label","description":"A human-readable label for the transaction fee model.","type":"string"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT"]},"value_type":{"title":"Value Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ABSOLUTE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RELATIVE -"},"children":[]}]}]}]}],"enum":["ABSOLUTE","RELATIVE"]},"application_type":{"title":"Application Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VOLUME -"},"children":[]}]}]}]}],"enum":["VOLUME"]},"base_amount_scope":{"title":"Base Amount Scope","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base amount scope of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER -"},"children":[]}]}]}]}],"enum":["ORDER"]},"tiers":{"description":"The tiers of the transaction fee model.","type":"array","items":{"title":"Fee Tier","oneOf":[{"title":"Absolute Transaction Fee Tier","description":"A single tier of a transaction fee model with a fixed, absolute cash amount.","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_amount"]},{"title":"Relative Transaction Fee Tier","description":"A single tier of a transaction fee model based on a percentage (defined in basis points).","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_bps":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"min_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"max_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_bps"]}]}}},"required":["label","currency","charge_method","value_type","application_type","base_amount_scope","tiers"],"additionalProperties":false},"id":"schema_1122"},"schema_1123":{"kind":"json-schema","data":{"title":"Fee Configuration","type":"object","properties":{"id":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"label":{"title":"Label","description":"A human-readable label for the transaction fee model.","type":"string"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"charge_method":{"title":"Fee charge method","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee will be charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT -"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT"]},"value_type":{"title":"Value Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ABSOLUTE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RELATIVE -"},"children":[]}]}]}]}],"enum":["ABSOLUTE","RELATIVE"]},"application_type":{"title":"Application Type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application type of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VOLUME -"},"children":[]}]}]}]}],"enum":["VOLUME"]},"base_amount_scope":{"title":"Base Amount Scope","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base amount scope of the transaction fee model."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER -"},"children":[]}]}]}]}],"enum":["ORDER"]},"tiers":{"description":"The tiers of the transaction fee model.","type":"array","items":{"title":"Fee Tier","oneOf":[{"title":"Absolute Transaction Fee Tier","description":"A single tier of a transaction fee model with a fixed, absolute cash amount.","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_amount"]},{"title":"Relative Transaction Fee Tier","description":"A single tier of a transaction fee model based on a percentage (defined in basis points).","type":"object","properties":{"tier_id":{"title":"The unique identifier for the fee tier.","type":"string","description":"The unique identifier for the fee tier.","pattern":"^[0-9]{1,63}$"},"base_amount_from":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"fee_bps":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"min_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},"max_fee_amount":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["tier_id","base_amount_from","fee_bps"]}]}}},"required":["id","created_at","updated_at","label","currency","charge_method","value_type","application_type","base_amount_scope","tiers"],"additionalProperties":false},"id":"schema_1123"},"schema_1124":{"kind":"json-schema","data":{"title":"Fee model unique identifier.","type":"string","description":"Fee model unique identifier.","format":"uuid"},"id":"schema_1124"},"schema_1125":{"kind":"json-schema","data":{"title":"Report type","oneOf":[{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},{"type":"string","enum":["ORDER_EX_ANTE_COST","ORDER_EX_ANTE_COST_SAVINGS_PLAN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”."},"children":[]}]}]}]}]},"id":"schema_1125"},"schema_1126":{"kind":"json-schema","data":{"oneOf":[{"title":"International securities identification number, prefixed with string 'isin:'","type":"string","description":"International securities identification number, prefixed with string 'isin:'","pattern":"^isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$"},{"title":"Unique identifier, prefixed with string 'uuid:'","type":"string","description":"Unique identifier, prefixed with string 'uuid:'","pattern":"^uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}],"example":"uuid:ebabcf4d-61c3-4942-875c-e265a7c2d062"},"id":"schema_1126"},"schema_1127":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns reports generated starting from and including this date (UTC)"},"id":"schema_1127"},"schema_1128":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns reports generated up until this date (UTC)"},"id":"schema_1128"},"schema_1129":{"kind":"json-schema","data":{"type":"string","enum":["id","type","created_at"],"default":"created_at"},"id":"schema_1129"},"schema_1130":{"kind":"json-schema","data":{"title":"Reports - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count","sort","order"]},"data":{"type":"array","items":{"title":"User Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1130"},"schema_1131":{"kind":"json-schema","data":{"title":"Report - Order ex-ante cost - Create - Request","description":"The order ex-ante cost report is generated by the client sharing the valid and relevant input data for the order.","oneOf":[{"title":"Report - Order ex-ante cost - Create - Request - Regular","type":"object","properties":{"type":{"type":"string","default":"ORDER_EX_ANTE_COST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST”."},"children":[]}]}]}]},"order":{"title":"Order","oneOf":[{"title":"Ex-Ante cost user order","type":"object","description":"Ex-ante order details for a user.","properties":{"user_id":{"type":"string","format":"uuid","description":"The user's ID."},"account_id":{"type":"string","format":"uuid","description":"Account ID owning the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]}},"additionalProperties":false,"required":["user_id","instrument_id","instrument_id_type","account_id","currency","order_type","side"]},{"title":"Ex-Ante Cost business order","type":"object","description":"Ex Ante Order details for a business.","properties":{"business_id":{"type":"string","format":"uuid","description":"The business's ID"},"account_id":{"type":"string","format":"uuid","description":"Account ID owning the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]}},"additionalProperties":false,"required":["business_id","instrument_id","instrument_id_type","account_id","currency","order_type","side"]}]},"fees":{"type":"array","description":"Client fees.","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_AUM_BASED_FEE -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL","ANNUAL_AUM_BASED_FEE"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of fee value must be “ABSOLUTE”."},"children":[]}]}]}]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["type","value_type","cash_amount","currency"],"additionalProperties":false},{"title":"Relative Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_AUM_BASED_FEE -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL","ANNUAL_AUM_BASED_FEE"]},"value_type":{"type":"string","default":"RELATIVE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of fee value must be “RELATIVE”."},"children":[]}]}]}]},"bps":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"A fee is charged based on transaction amount and is represented in basis points."}]}},"required":["type","value_type","bps"],"additionalProperties":false},{"title":"Transaction Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"inducements":{"type":"array","description":"Client inducements.","items":{"title":"Inducement","type":"object","properties":{"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of inducement value must be “ABSOLUTE”."},"children":[]}]}]}]},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["value_type","cash_amount","currency"],"additionalProperties":false}}},"required":["type","order"],"additionalProperties":false},{"title":"Report - Order ex-ante cost - Create - Request - Savings Plan","type":"object","properties":{"type":{"type":"string","default":"ORDER_EX_ANTE_COST_SAVINGS_PLAN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST_SAVINGS_PLAN”. Savings plan ex-ante reports are only supported for individual users, not for business entities."},"children":[]}]}]}]},"order":{"title":"Ex-Ante Cost Savings Plan order","type":"object","description":"Savings Plan Order details.","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the user."},"account_id":{"type":"string","format":"uuid","description":"Account ID owning the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"period":{"type":"string","enum":["WEEK","MONTH","YEAR"]},"interval":{"type":"string","pattern":"^[0-9]{1,63}$"}},"required":["instrument_id","instrument_id_type","account_id","user_id","cash_amount","currency","order_type","side","period","interval"]},"fees":{"type":"array","description":"Client fees.","items":{"title":"Fee","oneOf":[{"title":"Absolute Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_AUM_BASED_FEE -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL","ANNUAL_AUM_BASED_FEE"]},"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of fee value must be “ABSOLUTE”."},"children":[]}]}]}]},"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["type","value_type","cash_amount","currency"],"additionalProperties":false},{"title":"Relative Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_AUM_BASED_FEE -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL","ANNUAL_AUM_BASED_FEE"]},"value_type":{"type":"string","default":"RELATIVE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of fee value must be “RELATIVE”."},"children":[]}]}]}]},"bps":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"A fee is charged based on transaction amount and is represented in basis points."}]}},"required":["type","value_type","bps"],"additionalProperties":false},{"title":"Transaction Fee","type":"object","properties":{"type":{"title":"Fee type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_SELL -"},"children":[]}]}]}]}],"type":"string","enum":["TRANSACTION_FEE_BUY","TRANSACTION_FEE_SELL"]},"transaction_fee_model_id":{"type":"string","format":"uuid","description":"The ID of the transaction fee model."}},"required":["type","transaction_fee_model_id"],"additionalProperties":false}]}},"inducements":{"type":"array","description":"Client inducements.","items":{"title":"Inducement","type":"object","properties":{"value_type":{"type":"string","default":"ABSOLUTE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of inducement value must be “ABSOLUTE”."},"children":[]}]}]}]},"cash_amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]}},"required":["value_type","cash_amount","currency"],"additionalProperties":false}}},"required":["type","order"],"additionalProperties":false}]},"id":"schema_1131"},"schema_1132":{"kind":"json-schema","data":{"title":"Report - Order ex-ante cost","oneOf":[{"title":"User Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","enum":["ORDER_EX_ANTE_COST","ORDER_EX_ANTE_COST_SAVINGS_PLAN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"User Report Data - Order ex-ante cost","type":"object","description":"Contents of the order-ex-ante cost report for a user.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"user":{"type":"object","description":"User details.","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name of the user."},"last_name":{"type":"string","maxLength":100,"minLength":2,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addressed user's title is used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"address":{"type":"object","description":"User residential address.","properties":{"address_line1":{"type":"string","description":"First line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}}}}},"order":{"type":"object","description":"Order details.","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the user."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third-party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["user"],"additionalProperties":false}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"Business Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Business report type","type":"string","enum":["ORDER_EX_ANTE_COST"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST”. Savings plan ex-ante reports are not supported for business entities."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Business Report Data - Order ex-ante cost","type":"object","description":"Contents of the order ex-ante cost report for a business.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"business":{"type":"object","description":"Business details.","properties":{"company_name":{"type":"string","description":"Name of the company."},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}}},"order":{"type":"object","description":"Order details.","properties":{"business_id":{"type":"string","format":"uuid","description":"The ID of the business."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type STOP."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["business"],"additionalProperties":false}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false}]},"id":"schema_1132"},"schema_1133":{"kind":"json-schema","data":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"id":"schema_1133"},"schema_1134":{"kind":"json-schema","data":{"type":"string","enum":["application/json","application/pdf"],"description":"Report format","default":"application/json"},"id":"schema_1134"},"schema_1135":{"kind":"json-schema","data":{"title":"Report","anyOf":[{"title":"User Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"Business Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"User Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","enum":["ORDER_EX_ANTE_COST","ORDER_EX_ANTE_COST_SAVINGS_PLAN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"User Report Data - Order ex-ante cost","type":"object","description":"Contents of the order-ex-ante cost report for a user.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"user":{"type":"object","description":"User details.","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name of the user."},"last_name":{"type":"string","maxLength":100,"minLength":2,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addressed user's title is used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"address":{"type":"object","description":"User residential address.","properties":{"address_line1":{"type":"string","description":"First line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}}}}},"order":{"type":"object","description":"Order details.","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the user."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third-party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["user"],"additionalProperties":false}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"Business Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Business report type","type":"string","enum":["ORDER_EX_ANTE_COST"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST”. Savings plan ex-ante reports are not supported for business entities."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Business Report Data - Order ex-ante cost","type":"object","description":"Contents of the order ex-ante cost report for a business.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"business":{"type":"object","description":"Business details.","properties":{"company_name":{"type":"string","description":"Name of the company."},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}}},"order":{"type":"object","description":"Order details.","properties":{"business_id":{"type":"string","format":"uuid","description":"The ID of the business."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type STOP."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["business"],"additionalProperties":false}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false}]},"id":"schema_1135"},"schema_1136":{"kind":"json-schema","data":{"title":"Report"},"id":"schema_1136"},"schema_1137":{"kind":"json-schema","data":{"title":"Business Reports - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count","sort","order"]},"data":{"type":"array","items":{"title":"Business Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1137"},"schema_1138":{"kind":"json-schema","data":{"title":"Webhook - Reports - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["REPORT.CREATED"],"default":"REPORT.CREATED"},"object":{"title":"Report","anyOf":[{"title":"User Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"Business Report","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Report type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_CLOSING - Securities account closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_OPENING - Securities account opening"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_INCOME_STATEMENT - Annual tax income statement (\"Erträgnisaufstellung\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_TAX_STATEMENT - Annual tax reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANK_ACCOUNT_CONNECTED - Connect reference bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY_ORDER - Buy order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EX_POST_COST - Ex-post cost report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GENERIC_COMMUNICATION - Generic communication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOME_DISTRIBUTION - Income distribution report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY_BILLING_STATEMENT - Monthly billing activities statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVOKED_ORDER - Revoked buy or sell order (\"Storno\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_INCOMING - Securities are transferred in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL_ORDER - Sell order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund document (after tax optimization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRENCH_IFU - French tax statement (Imprimé fiscal unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Intake of service fees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value"},"children":[]}]}]}]}],"type":"string","enum":["ACCOUNT_CLOSING","ACCOUNT_OPENING","AD_HOC_ACCOUNT_STATEMENT","ANNUAL_INCOME_STATEMENT","ANNUAL_TAX_STATEMENT","BANK_ACCOUNT_CONNECTED","BUY_ORDER","CANCELLED_ORDER","CORPORATE_ACTION_CASH_TRANSACTION","CORPORATE_ACTION_SECURITY_TRANSACTION","DIRECT_DEBIT_MANDATE","EX_POST_COST","GENERIC_COMMUNICATION","INCOME_DISTRIBUTION","MONTHLY_BILLING_STATEMENT","QUARTERLY_ACCOUNT_STATEMENT","REVOKED_ORDER","SECURITIES_TRANSFER_INCOMING","SECURITIES_TRANSFER_OUTGOING","SELL_ORDER","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_PREPAYMENT_DE_CANCELLATION","TAX_REFUND","FRENCH_IFU","TAX_CONSOLIDATED_CERTIFICATE_UK","FEE_COLLECTION","LOSS_THRESHOLD"]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Report Data","type":"object","description":"Contents of the report.","properties":{"account":{"type":"object","title":"Account.","description":"Account information.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"}}},"references":{"type":"array","title":"References.","items":{"title":"Report reference data","type":"object","description":"Reference data for a report","properties":{"id":{"type":"string","format":"uuid"},"type":{"title":"Report reference type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report reference type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP_ID - Account group identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_ID - Account identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_ID - Order identifier"},"children":[]}]}]}]}],"type":"string","enum":["CORPORATE_ACTION_TRANSACTION_ID","ACCOUNT_GROUP_ID","ACCOUNT_ID","ORDER_ID"]}}}}}}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"User Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"type":{"type":"string","enum":["ORDER_EX_ANTE_COST","ORDER_EX_ANTE_COST_SAVINGS_PLAN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"User Report Data - Order ex-ante cost","type":"object","description":"Contents of the order-ex-ante cost report for a user.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"user":{"type":"object","description":"User details.","properties":{"first_name":{"type":"string","maxLength":100,"minLength":2,"description":"First name of the user."},"last_name":{"type":"string","maxLength":100,"minLength":2,"description":"Last name of the user."},"salutation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salutation of the user used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_MALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_FEMALE_MARRIED -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SALUTATION_DIVERSE -"},"children":[]}]}]}]}],"enum":["","SALUTATION_MALE","SALUTATION_FEMALE","SALUTATION_FEMALE_MARRIED","SALUTATION_DIVERSE"],"default":""},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addressed user's title is used in reports and statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(empty string) -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DR - Doctor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF - Professor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROF_DR -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIPL_ING - Graduate engineer (Diplom-Ingenieur)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAGISTER -"},"children":[]}]}]}]}],"enum":["","DR","PROF","PROF_DR","DIPL_ING","MAGISTER"],"default":""},"address":{"type":"object","description":"User residential address.","properties":{"address_line1":{"type":"string","description":"First line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}}}}},"order":{"type":"object","description":"Order details.","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the user."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type 'stop'."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third-party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["user"],"additionalProperties":false}},"required":["id","user_id","created_at","type","substituted_report_id"],"additionalProperties":false},{"title":"Business Report - Order ex-ante cost","type":"object","properties":{"id":{"title":"Report unique identifier.","type":"string","description":"Report unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"business_id":{"type":"string","description":"Unique identifier for the business.","format":"uuid"},"type":{"title":"Business report type","type":"string","enum":["ORDER_EX_ANTE_COST"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report must be “ORDER_EX_ANTE_COST”. Savings plan ex-ante reports are not supported for business entities."},"children":[]}]}]}]},"substituted_report_id":{"oneOf":[{"type":"null"},{"title":"Substituted Report unique identifier.","type":"string","description":"References report that has been replaced by this one.","format":"uuid"}]},"data":{"title":"Business Report Data - Order ex-ante cost","type":"object","description":"Contents of the order ex-ante cost report for a business.","properties":{"holding_period":{"type":"object","description":"Holding period.","properties":{"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEAR -"},"children":[]}]}]}]}],"enum":["YEAR"],"default":"YEAR"},"quantity":{"description":"Quantity of time units.","type":"integer"}}},"instrument":{"type":"object","description":"Instrument details.","properties":{"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"short_name":{"description":"Instrument short name.","type":"string","maxLength":100}}},"venue":{"type":"object","description":"Venue details.","properties":{"name":{"description":"Venue name.","type":"string","maxLength":100}}},"account":{"type":"object","description":"Account details.","properties":{"id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"account_number":{"type":"integer","description":"The serial account number of the account in the account group.","minimum":1}}},"account_group":{"type":"object","description":"Account group details.","properties":{"id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"securities_account_number":{"type":"string","description":"Securities account number.","pattern":"^[0-9]{9}$"}}},"business":{"type":"object","description":"Business details.","properties":{"company_name":{"type":"string","description":"Name of the company."},"address":{"title":"Address","type":"object","description":"Address. Must not be a P.O. box or c/o address.","properties":{"address_line1":{"type":"string","description":"First address line of the address.","maxLength":100},"address_line2":{"type":"string","description":"Second address line of the address.","maxLength":100},"postcode":{"title":"Postal code","type":"string","description":"Postal code (postcode, PIN or ZIP code)","pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\s\\-]{0,8}[a-zA-Z0-9]?$"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, province, county. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":50},"city":{"title":"City name","type":"string","minLength":1,"maxLength":85}},"required":["address_line1","postcode","country","city"]}}},"order":{"type":"object","description":"Order details.","properties":{"business_id":{"type":"string","format":"uuid","description":"The ID of the business."},"account_id":{"type":"string","format":"uuid","description":"The ID of the account that owns the order."},"cash_amount":{"allOf":[{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},{"description":"Cash amount for a nominal order."}]},"currency":{"allOf":[{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},{"description":"The currency for the order."}]},"side":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL -"},"children":[]}]}]}]}],"enum":["BUY","SELL"]},"instrument_id":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"instrument_id_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the ID used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISIN -"},"children":[]}]}]}]}],"enum":["ISIN"],"default":"ISIN","type":"string"},"order_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKET -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIMIT -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOP -"},"children":[]}]}]}]}],"enum":["MARKET","LIMIT","STOP"]},"quantity":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"Quantity of securities for the order."}]},"limit_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The limit price for orders of the type 'limit'."}]},"stop_price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The stop price for orders of the type STOP."}]},"price":{"allOf":[{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used."}]}}},"return_impact":{"type":"object","description":"Return impact.","properties":{"year_one":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_two":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"year_three":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}}},"total_cost":{"title":"Order ex-ante aggregated cost","type":"object","description":"Aggregated totals of product costs, service costs and third party payments.","properties":{"product":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"service":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"third_party":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"product_cost":{"title":"Order ex-ante product cost","type":"object","description":"All costs and associated charges related to the financial instrument.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"service_cost":{"title":"Order ex-ante service cost","type":"object","description":"All costs and associated charges related to the investment service(s) and/or ancillary services.","properties":{"one_off":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ongoing":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"transaction":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"ancillary":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"incidental":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false},"third_party_payments":{"type":"object","description":"Third party payments associated with the investment service.","properties":{"total":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_client":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false},"received_by_upvest":{"title":"Cost","type":"object","properties":{"cash_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]}]}],"enum":["EUR","GBP"]},"as_percentage":{"allOf":[{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"},{"description":"The cost value represented as a percentage."}]}},"additionalProperties":false}},"additionalProperties":false}},"required":["business"],"additionalProperties":false}},"required":["id","business_id","created_at","type","substituted_report_id"],"additionalProperties":false}]},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1138"},"schema_1139":{"kind":"json-schema","data":{"title":"Webhook - Treasury report - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["TREASURY_REPORT.CREATED"],"default":"TREASURY_REPORT.CREATED"},"object":{"title":"Treasury report","type":"object","properties":{"id":{"title":"Treasury operation unique identifier","type":"string","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treasury operation type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ADJUSTMENT_RECEIVABLE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ADJUSTMENT_PAYABLE -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE -"},"children":[]}]}]}]}],"enum":["TRADING","CORPORATE_ACTION","FEE","TAX","TAX_ADJUSTMENT_RECEIVABLE","TAX_ADJUSTMENT_PAYABLE","TRANSACTION_FEE"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the treasury payment. Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]}]},"settlement_amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"report_date":{"description":"The date when the treasury report was created.","type":"string","format":"date"},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the treasury operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING -"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA -"},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING","NA"]},"filename":{"description":"The report name.","type":"string"}},"required":["id","type","currency","settlement_amount","report_date","direction","filename"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1139"},"schema_1140":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns transactions starting from and including this date (UTC).","example":"2023-01-03"},"id":"schema_1140"},"schema_1141":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns transactions up until this date (UTC)","example":"2023-01-11"},"id":"schema_1141"},"schema_1142":{"kind":"json-schema","data":{"type":"string","enum":["booking_date"],"default":"booking_date"},"id":"schema_1142"},"schema_1143":{"kind":"json-schema","data":{"title":"Cash transaction - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Cash Transaction","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"booking_date":{"title":" Transaction booking date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction booking date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"delta":{"title":"Cash transaction delta","description":"Entity representing cash transaction delta.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["amount","currency"],"additionalProperties":false},"id":{"title":"Cash transaction unique identifier","type":"string","description":"Cash transaction unique identifier.","format":"uuid"},"instrument":{"title":"Instrument","description":"Entity representing instrument.","type":"object","properties":{"uuid":{"description":"Internal instrument identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"taxes":{"type":"array","items":{"title":"Transaction tax","description":"Entity representing the transaction tax.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total taxes"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"}},"required":["amount","currency","type"],"additionalProperties":false}},"taxes_details":{"title":"Transaction taxes details","description":"Entity representing the transaction taxes details.","type":"object","properties":{"total_amount":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["amount","currency"]},"tax_breakdown":{"type":"array","items":{"title":"Transaction tax","description":"Entity representing the transaction tax.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":"Type of the tax.","enum":["CAPITAL_GAINS","CHURCH_TAX","SOLIDARITY_SURCHARGE","FINANCIAL_TRANSACTION_TAX","STAMP_DUTY","INTERNATIONAL_WITHHOLDING_TAX"]},"taxing_jurisdiction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"}},"required":["amount","currency","type","taxing_jurisdiction"],"additionalProperties":false}}},"required":["total_amount","tax_breakdown"],"additionalProperties":false},"fees":{"type":"array","items":{"title":"Transaction fee","description":"Entity representing the transaction fee.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total fees"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"},"charge_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee was charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT - Charged by client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST - Charged by client and collected by Upvest"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]}},"required":["amount","currency","type","charge_method"],"additionalProperties":false}},"references":{"type":"array","items":{"title":"Cash transaction reference","description":"Entity representing cash transaction reference.","type":"object","properties":{"id":{"title":"Unique identifier for a resource of given type","type":"string","description":"Unique identifier for a resource of given type.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP - Account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_BALANCE_TRANSFER - Cash balance transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION - Corporate action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING - Credit Funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT - Direct debit funding request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_TRANSFER - ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER - Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_TRANSACTION - Tax transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP - Cash top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_EXECUTION - Transaction fee execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_DECREASE - Virtual cash decreased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_INCREASE - Virtual cash increased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL - Cash withdrawal"},"children":[]}]}]}]}],"enum":["ACCOUNT_GROUP","CASH_BALANCE_TRANSFER","CORPORATE_ACTION","CORPORATE_ACTION_TRANSACTION_ID","CREDIT_FUNDING","DIRECT_DEBIT","FEE_COLLECTION","ISA_TRANSFER","ORDER","ORDER_EXECUTION","TAX_TRANSACTION","TOPUP","TRANSACTION_FEE_EXECUTION","VIRTUAL_CASH_DECREASE","VIRTUAL_CASH_INCREASE","WITHDRAWAL"]}},"required":["id","type"],"additionalProperties":false}},"type":{"title":"Transaction type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION - Accumulation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION_CANCELLATION - Accumulation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING - Annual general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT - Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT_CANCELLATION - Attachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION - Balance correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY - Bankruptcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY_CANCELLATION - Bankruptcy cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT - Bond default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT_CANCELLATION - Bond default cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING - Bond holder meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE - Bonus Issue/Capitalisation Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION - Capital distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION - Capitalisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION_CANCELLATION - Capitalisation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND - Cash dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE - Change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE_CANCELLATION - Change, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION - Class action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION_CANCELLATION - Class action cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION - Company option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION_CANCELLATION - Company option cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT - Consent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT_CANCELLATION - Consent cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION - Conversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION_CANCELLATION - Conversion cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING - Court meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING_CANCELLATION - Court meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT - Credit event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT_CANCELLATION - Credit event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING - Credit funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING_CHARGE_BACK - Credit funding charge back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD_REFUND_REJECT_FEE - Direct debit refund reject fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD_REFUND_REJECT_FEE_CANCELLATION - Direct debit refund reject fee cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE - Decrease in Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE_CANCELLATION - Decrease in Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT - Detachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT_CANCELLATION - Detachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE - Disclosure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE_CANCELLATION - Disclosure cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION - Dividend Option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT - Dividend Reinvestment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING - Drawing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING_CANCELLATION - Drawing cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION - Dutch Auction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE - Exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE_CANCELLATION - Exchange cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION_CANCELLATION - Fee collection cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY - Final maturity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY_CANCELLATION - Final maturity cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL - Full call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL_CANCELLATION - Full call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE - Increase in Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE_CANCELLATION - Increase in Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION - Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION_CANCELLATION - Information cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL - Instalment call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL_CANCELLATION - Instalment call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT - Interest payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_CASH_TRANSFER - Internal cash transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_CASH_TRANSFER_CANCELLATION - Internal cash transfer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_TRANSFER - ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION - Maturity extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER - Merger"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER_CANCELLATION - Merger, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER - Non-Official Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE - Odd Lot Sale/Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION_CANCELLATION - Order execution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING - Ordinary general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT - Other Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT_CANCELLATION - Other Event, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU - Pari passu"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU_CANCELLATION - Pari passu cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE - Partial defeasance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND - Pay in kind"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND_CANCELLATION - Pay in kind cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_FRACTION_COMPENSATION - Peak fraction compensation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_ORDER_ADJUSTMENT - Peak order adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION - Place of incorporation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE - Priority Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION - Put redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION_CANCELLATION - Put redemption cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION - Redenomination"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION_CANCELLATION - Redenomination cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT - Remarketing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND - Scrip dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA_DIRECT_DEBIT - Sepa direct debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA_DIRECT_DEBIT_CHARGE_BACK - Sepa direct debit charge back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND - Shares Premium Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares Premium Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF - Spin-Off"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF_CANCELLATION - Spin-Off, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND - Stock Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM - Tax reclaim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER - Tender/Acquisition/Takeover/Purchase Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP - Cash top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP_CANCELLATION - Top up cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE - Trading status active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED - Trading status delisted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED - Trading status suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TREASURY_PAYMENT - Treasury payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION - Virtual cash correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_DECREASE - Virtual cash decreased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_INCREASE - Virtual cash increased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE - Warrant exercise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL - Withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL_CANCELLATION - Withdrawal cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS - Worthless"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS_CANCELLATION - Worthless, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation"},"children":[]}]}]}]}],"type":"string","enum":["ACCUMULATION","ACCUMULATION_CANCELLATION","ANNUAL_GENERAL_MEETING","ANNUAL_GENERAL_MEETING_CANCELLATION","ATTACHMENT","ATTACHMENT_CANCELLATION","BALANCE_CORRECTION","BALANCE_CORRECTION_CANCELLATION","BANKRUPTCY","BANKRUPTCY_CANCELLATION","BOND_DEFAULT","BOND_DEFAULT_CANCELLATION","BOND_HOLDER_MEETING","BOND_HOLDER_MEETING_CANCELLATION","BONUS_ISSUE","BONUS_ISSUE_CANCELLATION","CALL_ON_INTERMEDIATE_SECURITIES","CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION","CAPITAL_DISTRIBUTION","CAPITAL_DISTRIBUTION_CANCELLATION","CAPITAL_GAINS_DISTRIBUTION","CAPITAL_GAINS_DISTRIBUTION_CANCELLATION","CAPITALISATION","CAPITALISATION_CANCELLATION","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION","CASH_DIVIDEND","CASH_DIVIDEND_CANCELLATION","CHANGE","CHANGE_CANCELLATION","CLASS_ACTION","CLASS_ACTION_CANCELLATION","COMPANY_OPTION","COMPANY_OPTION_CANCELLATION","CONSENT","CONSENT_CANCELLATION","CONVERSION","CONVERSION_CANCELLATION","COURT_MEETING","COURT_MEETING_CANCELLATION","CREDIT_EVENT","CREDIT_EVENT_CANCELLATION","CREDIT_FUNDING","CREDIT_FUNDING_CHARGE_BACK","DD_REFUND_REJECT_FEE","DD_REFUND_REJECT_FEE_CANCELLATION","DECREASE_IN_VALUE","DECREASE_IN_VALUE_CANCELLATION","DETACHMENT","DETACHMENT_CANCELLATION","DISCLOSURE","DISCLOSURE_CANCELLATION","DIVIDEND_OPTION","DIVIDEND_OPTION_CANCELLATION","DIVIDEND_REINVESTMENT","DIVIDEND_REINVESTMENT_CANCELLATION","DRAWING","DRAWING_CANCELLATION","DUTCH_AUCTION","DUTCH_AUCTION_CANCELLATION","EXCHANGE","EXCHANGE_CANCELLATION","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION","FEE_COLLECTION","FEE_COLLECTION_CANCELLATION","FINAL_MATURITY","FINAL_MATURITY_CANCELLATION","FULL_CALL","FULL_CALL_CANCELLATION","INCREASE_IN_VALUE","INCREASE_IN_VALUE_CANCELLATION","INFORMATION","INFORMATION_CANCELLATION","INSTALMENT_CALL","INSTALMENT_CALL_CANCELLATION","INTEREST_PAYMENT","INTEREST_PAYMENT_CANCELLATION","INTERMEDIATE_SECURITIES_DISTRIBUTION","INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION","INTERNAL_CASH_TRANSFER","INTERNAL_CASH_TRANSFER_CANCELLATION","ISA_TRANSFER","LIQUIDATION_PAYMENT","LIQUIDATION_PAYMENT_CANCELLATION","MATURITY_EXTENSION","MATURITY_EXTENSION_CANCELLATION","MERGER","MERGER_CANCELLATION","NON_OFFICIAL_OFFER","NON_OFFICIAL_OFFER_CANCELLATION","NON_US_TEFRA_D_CERTIFICATION","NON_US_TEFRA_D_CERTIFICATION_CANCELLATION","ODD_LOT_SALE","ODD_LOT_SALE_CANCELLATION","ORDER_EXECUTION","ORDER_EXECUTION_CANCELLATION","ORDINARY_GENERAL_MEETING","ORDINARY_GENERAL_MEETING_CANCELLATION","OTHER_EVENT","OTHER_EVENT_CANCELLATION","PARI_PASSU","PARI_PASSU_CANCELLATION","PARTIAL_DEFEASANCE","PARTIAL_DEFEASANCE_CANCELLATION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION","PAY_IN_KIND","PAY_IN_KIND_CANCELLATION","PEAK_FRACTION_COMPENSATION","PEAK_ORDER_ADJUSTMENT","PLACE_OF_INCORPORATION","PLACE_OF_INCORPORATION_CANCELLATION","PRIORITY_ISSUE","PRIORITY_ISSUE_CANCELLATION","PUT_REDEMPTION","PUT_REDEMPTION_CANCELLATION","REDENOMINATION","REDENOMINATION_CANCELLATION","REMARKETING_AGREEMENT","REMARKETING_AGREEMENT_CANCELLATION","REPURCHASE_OFFER","REPURCHASE_OFFER_CANCELLATION","REVERSE_STOCK_SPLIT","REVERSE_STOCK_SPLIT_CANCELLATION","RIGHTS_ISSUE","RIGHTS_ISSUE_CANCELLATION","SCRIP_DIVIDEND","SCRIP_DIVIDEND_CANCELLATION","SEPA_DIRECT_DEBIT","SEPA_DIRECT_DEBIT_CHARGE_BACK","SHARES_PREMIUM_DIVIDEND","SHARES_PREMIUM_DIVIDEND_CANCELLATION","SMALLEST_NEGOTIABLE_UNIT","SMALLEST_NEGOTIABLE_UNIT_CANCELLATION","SPIN_OFF","SPIN_OFF_CANCELLATION","STOCK_DIVIDEND","STOCK_DIVIDEND_CANCELLATION","STOCK_SPLIT","STOCK_SPLIT_CANCELLATION","TAX_ON_NON_DISTRIBUTED_PROCEEDS","TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_RECLAIM","TAX_RECLAIM_CANCELLATION","TAX_REFUND","TENDER","TENDER_CANCELLATION","TOPUP","TOPUP_CANCELLATION","TRADING_STATUS_ACTIVE","TRADING_STATUS_ACTIVE_CANCELLATION","TRADING_STATUS_DELISTED","TRADING_STATUS_DELISTED_CANCELLATION","TRADING_STATUS_SUSPENDED","TRADING_STATUS_SUSPENDED_CANCELLATION","TREASURY_PAYMENT","VIRTUAL_CASH_CORRECTION","VIRTUAL_CASH_CORRECTION_CANCELLATION","VIRTUAL_CASH_DECREASE","VIRTUAL_CASH_INCREASE","WARRANT_EXERCISE","WARRANT_EXERCISE_CANCELLATION","WITHDRAWAL","WITHDRAWAL_CANCELLATION","WORTHLESS","WORTHLESS_CANCELLATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION"]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"value_date":{"title":"Transaction value date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction value date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"}},"required":["id","type","account_group_id","delta","taxes","taxes_details","references","booking_date","value_date","created_at","updated_at"],"additionalProperties":true}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1143"},"schema_1144":{"kind":"json-schema","data":{"type":"string","format":"date","title":"Date in YYYY-MM-DD format. RFC 3339, section 5.6","description":"Returns transactions starting from and including this date (UTC)"},"id":"schema_1144"},"schema_1145":{"kind":"json-schema","data":{"title":"Security transaction - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Security Transaction","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"booking_date":{"title":" Transaction booking date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction booking date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"delta":{"title":"Security transaction delta","description":"Entity representing the security transaction delta.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["amount"],"additionalProperties":true},"id":{"title":"Security transaction unique identifier","type":"string","description":"Security transaction unique identifier.","format":"uuid"},"instrument":{"title":"Instrument","description":"Entity representing instrument.","type":"object","properties":{"uuid":{"description":"Internal instrument identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"type":{"title":"Transaction type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION - Accumulation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION_CANCELLATION - Accumulation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING - Annual general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT - Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT_CANCELLATION - Attachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION - Balance correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY - Bankruptcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY_CANCELLATION - Bankruptcy cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT - Bond default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT_CANCELLATION - Bond default cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING - Bond holder meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE - Bonus Issue/Capitalisation Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION - Capital distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION - Capitalisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION_CANCELLATION - Capitalisation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND - Cash dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE - Change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE_CANCELLATION - Change, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION - Class action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION_CANCELLATION - Class action cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION - Company option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION_CANCELLATION - Company option cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT - Consent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT_CANCELLATION - Consent cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION - Conversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION_CANCELLATION - Conversion cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING - Court meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING_CANCELLATION - Court meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT - Credit event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT_CANCELLATION - Credit event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE - Decrease in value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE_CANCELLATION - Decrease in value cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT - Detachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT_CANCELLATION - Detachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE - Disclosure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE_CANCELLATION - Disclosure cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION - Dividend Option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT - Dividend Reinvestment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING - Drawing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING_CANCELLATION - Drawing cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUST_CLEANUP - Dust Cleanup"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION - Dutch Auction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE - Exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE_CANCELLATION - Exchange cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY - Final maturity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY_CANCELLATION - Final maturity cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL - Full call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL_CANCELLATION - Full call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE - Increase in value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE_CANCELLATION - Increase in value cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION - Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION_CANCELLATION - Information cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL - Instalment call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL_CANCELLATION - Instalment call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT - Interest payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION - Maturity extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER - Merger"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER_CANCELLATION - Merger, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER - Non-Official Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE - Odd Lot Sale/Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION_CANCELLATION - Order execution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING - Ordinary general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT - Other Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT_CANCELLATION - Other Event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU - Pari passu"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU_CANCELLATION - Pari passu cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE - Partial defeasance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND - Pay in kind"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND_CANCELLATION - Pay in kind cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_FRACTION_COMPENSATION - Peak fraction compensation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_ORDER_ADJUSTMENT - Peak order adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION - Place of incorporation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE - Priority Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION - Put redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION_CANCELLATION - Put redemption cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION - Redenomination"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION_CANCELLATION - Redenomination cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT - Remarketing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND - Scrip dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER - Securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_CANCELLATION - Securities transfer cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND - Shares premium dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares premium dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF - Spin-Off"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF_CANCELLATION - Spin-Off, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND - Stock Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM - Tax reclaim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER - Tender/Acquisition/Takeover/Purchase Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE - Trading status active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED - Trading status delisted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED - Trading status suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE - Warrant exercise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS - Worthless"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS_CANCELLATION - Worthless, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_LENDING - Securities lending"},"children":[]}]}]}]}],"type":"string","enum":["ACCUMULATION","ACCUMULATION_CANCELLATION","ANNUAL_GENERAL_MEETING","ANNUAL_GENERAL_MEETING_CANCELLATION","ATTACHMENT","ATTACHMENT_CANCELLATION","BALANCE_CORRECTION","BALANCE_CORRECTION_CANCELLATION","BANKRUPTCY","BANKRUPTCY_CANCELLATION","BOND_DEFAULT","BOND_DEFAULT_CANCELLATION","BOND_HOLDER_MEETING","BOND_HOLDER_MEETING_CANCELLATION","BONUS_ISSUE","BONUS_ISSUE_CANCELLATION","CALL_ON_INTERMEDIATE_SECURITIES","CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION","CAPITAL_DISTRIBUTION","CAPITAL_DISTRIBUTION_CANCELLATION","CAPITAL_GAINS_DISTRIBUTION","CAPITAL_GAINS_DISTRIBUTION_CANCELLATION","CAPITALISATION","CAPITALISATION_CANCELLATION","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION","CASH_DIVIDEND","CASH_DIVIDEND_CANCELLATION","CHANGE","CHANGE_CANCELLATION","CLASS_ACTION","CLASS_ACTION_CANCELLATION","COMPANY_OPTION","COMPANY_OPTION_CANCELLATION","CONSENT","CONSENT_CANCELLATION","CONVERSION","CONVERSION_CANCELLATION","COURT_MEETING","COURT_MEETING_CANCELLATION","CREDIT_EVENT","CREDIT_EVENT_CANCELLATION","DECREASE_IN_VALUE","DECREASE_IN_VALUE_CANCELLATION","DETACHMENT","DETACHMENT_CANCELLATION","DISCLOSURE","DISCLOSURE_CANCELLATION","DIVIDEND_OPTION","DIVIDEND_OPTION_CANCELLATION","DIVIDEND_REINVESTMENT","DIVIDEND_REINVESTMENT_CANCELLATION","DRAWING","DRAWING_CANCELLATION","DUST_CLEANUP","DUTCH_AUCTION","DUTCH_AUCTION_CANCELLATION","EXCHANGE","EXCHANGE_CANCELLATION","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION","FINAL_MATURITY","FINAL_MATURITY_CANCELLATION","FULL_CALL","FULL_CALL_CANCELLATION","INCREASE_IN_VALUE","INCREASE_IN_VALUE_CANCELLATION","INFORMATION","INFORMATION_CANCELLATION","INSTALMENT_CALL","INSTALMENT_CALL_CANCELLATION","INTEREST_PAYMENT","INTEREST_PAYMENT_CANCELLATION","INTERMEDIATE_SECURITIES_DISTRIBUTION","INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION","LIQUIDATION_PAYMENT","LIQUIDATION_PAYMENT_CANCELLATION","MATURITY_EXTENSION","MATURITY_EXTENSION_CANCELLATION","MERGER","MERGER_CANCELLATION","NON_OFFICIAL_OFFER","NON_OFFICIAL_OFFER_CANCELLATION","NON_US_TEFRA_D_CERTIFICATION","NON_US_TEFRA_D_CERTIFICATION_CANCELLATION","ODD_LOT_SALE","ODD_LOT_SALE_CANCELLATION","ORDER_EXECUTION","ORDER_EXECUTION_CANCELLATION","ORDINARY_GENERAL_MEETING","ORDINARY_GENERAL_MEETING_CANCELLATION","OTHER_EVENT","OTHER_EVENT_CANCELLATION","PARI_PASSU","PARI_PASSU_CANCELLATION","PARTIAL_DEFEASANCE","PARTIAL_DEFEASANCE_CANCELLATION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION","PAY_IN_KIND","PAY_IN_KIND_CANCELLATION","PEAK_FRACTION_COMPENSATION","PEAK_ORDER_ADJUSTMENT","PLACE_OF_INCORPORATION","PLACE_OF_INCORPORATION_CANCELLATION","PRIORITY_ISSUE","PRIORITY_ISSUE_CANCELLATION","PUT_REDEMPTION","PUT_REDEMPTION_CANCELLATION","REDENOMINATION","REDENOMINATION_CANCELLATION","REMARKETING_AGREEMENT","REMARKETING_AGREEMENT_CANCELLATION","REPURCHASE_OFFER","REPURCHASE_OFFER_CANCELLATION","REVERSE_STOCK_SPLIT","REVERSE_STOCK_SPLIT_CANCELLATION","RIGHTS_ISSUE","RIGHTS_ISSUE_CANCELLATION","SCRIP_DIVIDEND","SCRIP_DIVIDEND_CANCELLATION","SECURITIES_TRANSFER","SECURITIES_TRANSFER_CANCELLATION","SHARES_PREMIUM_DIVIDEND","SHARES_PREMIUM_DIVIDEND_CANCELLATION","SMALLEST_NEGOTIABLE_UNIT","SMALLEST_NEGOTIABLE_UNIT_CANCELLATION","SPIN_OFF","SPIN_OFF_CANCELLATION","STOCK_DIVIDEND","STOCK_DIVIDEND_CANCELLATION","STOCK_SPLIT","STOCK_SPLIT_CANCELLATION","TAX_ON_NON_DISTRIBUTED_PROCEEDS","TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION","TAX_RECLAIM","TAX_RECLAIM_CANCELLATION","TENDER","TENDER_CANCELLATION","TRADING_STATUS_ACTIVE","TRADING_STATUS_ACTIVE_CANCELLATION","TRADING_STATUS_DELISTED","TRADING_STATUS_DELISTED_CANCELLATION","TRADING_STATUS_SUSPENDED","TRADING_STATUS_SUSPENDED_CANCELLATION","VIRTUAL_CASH_CORRECTION_CANCELLATION","WARRANT_EXERCISE","WARRANT_EXERCISE_CANCELLATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION","WORTHLESS","WORTHLESS_CANCELLATION","SECURITIES_LENDING"]},"references":{"type":"array","items":{"title":"Security transaction reference","description":"Entity representing security transaction reference.","type":"object","properties":{"id":{"title":"Unique identifier for a resource of given type","type":"string","description":"Unique identifier for a resource of given type.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER - Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION - Corporate action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID"},"children":[]}]}]}]}],"enum":["ORDER","ORDER_EXECUTION","CORPORATE_ACTION","CORPORATE_ACTION_TRANSACTION_ID"]}},"required":["id","type"],"additionalProperties":false}},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"value_date":{"title":"Transaction value date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction value date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"}},"required":["id","type","account_id","account_group_id","instrument","delta","references","value_date","booking_date","created_at","updated_at"],"additionalProperties":true}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1145"},"schema_1146":{"kind":"json-schema","data":{"title":"Webhook - Cash Transactions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["CASH_TRANSACTION.EXECUTED"],"default":"CASH_TRANSACTION.EXECUTED"},"object":{"title":"Cash Transaction","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"booking_date":{"title":" Transaction booking date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction booking date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"delta":{"title":"Cash transaction delta","description":"Entity representing cash transaction delta.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["amount","currency"],"additionalProperties":false},"id":{"title":"Cash transaction unique identifier","type":"string","description":"Cash transaction unique identifier.","format":"uuid"},"instrument":{"title":"Instrument","description":"Entity representing instrument.","type":"object","properties":{"uuid":{"description":"Internal instrument identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"taxes":{"type":"array","items":{"title":"Transaction tax","description":"Entity representing the transaction tax.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total taxes"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"}},"required":["amount","currency","type"],"additionalProperties":false}},"taxes_details":{"title":"Transaction taxes details","description":"Entity representing the transaction taxes details.","type":"object","properties":{"total_amount":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]}},"required":["amount","currency"]},"tax_breakdown":{"type":"array","items":{"title":"Transaction tax","description":"Entity representing the transaction tax.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":"Type of the tax.","enum":["CAPITAL_GAINS","CHURCH_TAX","SOLIDARITY_SURCHARGE","FINANCIAL_TRANSACTION_TAX","STAMP_DUTY","INTERNATIONAL_WITHHOLDING_TAX"]},"taxing_jurisdiction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"}},"required":["amount","currency","type","taxing_jurisdiction"],"additionalProperties":false}}},"required":["total_amount","tax_breakdown"],"additionalProperties":false},"fees":{"type":"array","items":{"title":"Transaction fee","description":"Entity representing the transaction fee.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EUR - Euro"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP - Pound Sterling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD - The United States dollar"},"children":[]}]}]}]}],"enum":["EUR","GBP","USD"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOTAL - Total fees"},"children":[]}]}]}]}],"enum":["TOTAL"],"default":"TOTAL"},"charge_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fee was charged by client or by other methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHARGED_BY_CLIENT - Charged by client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECTED_BY_UPVEST - Charged by client and collected by Upvest"},"children":[]}]}]}]}],"enum":["CHARGED_BY_CLIENT","COLLECTED_BY_UPVEST"]}},"required":["amount","currency","type","charge_method"],"additionalProperties":false}},"references":{"type":"array","items":{"title":"Cash transaction reference","description":"Entity representing cash transaction reference.","type":"object","properties":{"id":{"title":"Unique identifier for a resource of given type","type":"string","description":"Unique identifier for a resource of given type.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_GROUP - Account group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_BALANCE_TRANSFER - Cash balance transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION - Corporate action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING - Credit Funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_DEBIT - Direct debit funding request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_TRANSFER - ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER - Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_TRANSACTION - Tax transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP - Cash top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSACTION_FEE_EXECUTION - Transaction fee execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_DECREASE - Virtual cash decreased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_INCREASE - Virtual cash increased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL - Cash withdrawal"},"children":[]}]}]}]}],"enum":["ACCOUNT_GROUP","CASH_BALANCE_TRANSFER","CORPORATE_ACTION","CORPORATE_ACTION_TRANSACTION_ID","CREDIT_FUNDING","DIRECT_DEBIT","FEE_COLLECTION","ISA_TRANSFER","ORDER","ORDER_EXECUTION","TAX_TRANSACTION","TOPUP","TRANSACTION_FEE_EXECUTION","VIRTUAL_CASH_DECREASE","VIRTUAL_CASH_INCREASE","WITHDRAWAL"]}},"required":["id","type"],"additionalProperties":false}},"type":{"title":"Transaction type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION - Accumulation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION_CANCELLATION - Accumulation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING - Annual general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT - Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT_CANCELLATION - Attachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION - Balance correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY - Bankruptcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY_CANCELLATION - Bankruptcy cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT - Bond default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT_CANCELLATION - Bond default cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING - Bond holder meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE - Bonus Issue/Capitalisation Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION - Capital distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION - Capitalisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION_CANCELLATION - Capitalisation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND - Cash dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE - Change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE_CANCELLATION - Change, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION - Class action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION_CANCELLATION - Class action cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION - Company option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION_CANCELLATION - Company option cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT - Consent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT_CANCELLATION - Consent cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION - Conversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION_CANCELLATION - Conversion cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING - Court meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING_CANCELLATION - Court meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT - Credit event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT_CANCELLATION - Credit event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING - Credit funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_FUNDING_CHARGE_BACK - Credit funding charge back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD_REFUND_REJECT_FEE - Direct debit refund reject fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD_REFUND_REJECT_FEE_CANCELLATION - Direct debit refund reject fee cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE - Decrease in Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE_CANCELLATION - Decrease in Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT - Detachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT_CANCELLATION - Detachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE - Disclosure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE_CANCELLATION - Disclosure cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION - Dividend Option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT - Dividend Reinvestment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING - Drawing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING_CANCELLATION - Drawing cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION - Dutch Auction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE - Exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE_CANCELLATION - Exchange cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION - Fee collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEE_COLLECTION_CANCELLATION - Fee collection cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY - Final maturity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY_CANCELLATION - Final maturity cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL - Full call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL_CANCELLATION - Full call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE - Increase in Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE_CANCELLATION - Increase in Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION - Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION_CANCELLATION - Information cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL - Instalment call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL_CANCELLATION - Instalment call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT - Interest payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_CASH_TRANSFER - Internal cash transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_CASH_TRANSFER_CANCELLATION - Internal cash transfer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISA_TRANSFER - ISA transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION - Maturity extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER - Merger"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER_CANCELLATION - Merger, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER - Non-Official Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE - Odd Lot Sale/Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION_CANCELLATION - Order execution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING - Ordinary general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT - Other Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT_CANCELLATION - Other Event, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU - Pari passu"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU_CANCELLATION - Pari passu cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE - Partial defeasance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND - Pay in kind"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND_CANCELLATION - Pay in kind cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_FRACTION_COMPENSATION - Peak fraction compensation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_ORDER_ADJUSTMENT - Peak order adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION - Place of incorporation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE - Priority Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION - Put redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION_CANCELLATION - Put redemption cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION - Redenomination"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION_CANCELLATION - Redenomination cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT - Remarketing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND - Scrip dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA_DIRECT_DEBIT - Sepa direct debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SEPA_DIRECT_DEBIT_CHARGE_BACK - Sepa direct debit charge back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND - Shares Premium Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares Premium Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF - Spin-Off"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF_CANCELLATION - Spin-Off, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND - Stock Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PAYMENT - Tax payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM - Tax reclaim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_REFUND - Tax refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER - Tender/Acquisition/Takeover/Purchase Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP - Cash top up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOPUP_CANCELLATION - Top up cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE - Trading status active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED - Trading status delisted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED - Trading status suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TREASURY_PAYMENT - Treasury payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION - Virtual cash correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_DECREASE - Virtual cash decreased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_INCREASE - Virtual cash increased"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE - Warrant exercise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL - Withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHDRAWAL_CANCELLATION - Withdrawal cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS - Worthless"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS_CANCELLATION - Worthless, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation"},"children":[]}]}]}]}],"type":"string","enum":["ACCUMULATION","ACCUMULATION_CANCELLATION","ANNUAL_GENERAL_MEETING","ANNUAL_GENERAL_MEETING_CANCELLATION","ATTACHMENT","ATTACHMENT_CANCELLATION","BALANCE_CORRECTION","BALANCE_CORRECTION_CANCELLATION","BANKRUPTCY","BANKRUPTCY_CANCELLATION","BOND_DEFAULT","BOND_DEFAULT_CANCELLATION","BOND_HOLDER_MEETING","BOND_HOLDER_MEETING_CANCELLATION","BONUS_ISSUE","BONUS_ISSUE_CANCELLATION","CALL_ON_INTERMEDIATE_SECURITIES","CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION","CAPITAL_DISTRIBUTION","CAPITAL_DISTRIBUTION_CANCELLATION","CAPITAL_GAINS_DISTRIBUTION","CAPITAL_GAINS_DISTRIBUTION_CANCELLATION","CAPITALISATION","CAPITALISATION_CANCELLATION","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION","CASH_DIVIDEND","CASH_DIVIDEND_CANCELLATION","CHANGE","CHANGE_CANCELLATION","CLASS_ACTION","CLASS_ACTION_CANCELLATION","COMPANY_OPTION","COMPANY_OPTION_CANCELLATION","CONSENT","CONSENT_CANCELLATION","CONVERSION","CONVERSION_CANCELLATION","COURT_MEETING","COURT_MEETING_CANCELLATION","CREDIT_EVENT","CREDIT_EVENT_CANCELLATION","CREDIT_FUNDING","CREDIT_FUNDING_CHARGE_BACK","DD_REFUND_REJECT_FEE","DD_REFUND_REJECT_FEE_CANCELLATION","DECREASE_IN_VALUE","DECREASE_IN_VALUE_CANCELLATION","DETACHMENT","DETACHMENT_CANCELLATION","DISCLOSURE","DISCLOSURE_CANCELLATION","DIVIDEND_OPTION","DIVIDEND_OPTION_CANCELLATION","DIVIDEND_REINVESTMENT","DIVIDEND_REINVESTMENT_CANCELLATION","DRAWING","DRAWING_CANCELLATION","DUTCH_AUCTION","DUTCH_AUCTION_CANCELLATION","EXCHANGE","EXCHANGE_CANCELLATION","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION","FEE_COLLECTION","FEE_COLLECTION_CANCELLATION","FINAL_MATURITY","FINAL_MATURITY_CANCELLATION","FULL_CALL","FULL_CALL_CANCELLATION","INCREASE_IN_VALUE","INCREASE_IN_VALUE_CANCELLATION","INFORMATION","INFORMATION_CANCELLATION","INSTALMENT_CALL","INSTALMENT_CALL_CANCELLATION","INTEREST_PAYMENT","INTEREST_PAYMENT_CANCELLATION","INTERMEDIATE_SECURITIES_DISTRIBUTION","INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION","INTERNAL_CASH_TRANSFER","INTERNAL_CASH_TRANSFER_CANCELLATION","ISA_TRANSFER","LIQUIDATION_PAYMENT","LIQUIDATION_PAYMENT_CANCELLATION","MATURITY_EXTENSION","MATURITY_EXTENSION_CANCELLATION","MERGER","MERGER_CANCELLATION","NON_OFFICIAL_OFFER","NON_OFFICIAL_OFFER_CANCELLATION","NON_US_TEFRA_D_CERTIFICATION","NON_US_TEFRA_D_CERTIFICATION_CANCELLATION","ODD_LOT_SALE","ODD_LOT_SALE_CANCELLATION","ORDER_EXECUTION","ORDER_EXECUTION_CANCELLATION","ORDINARY_GENERAL_MEETING","ORDINARY_GENERAL_MEETING_CANCELLATION","OTHER_EVENT","OTHER_EVENT_CANCELLATION","PARI_PASSU","PARI_PASSU_CANCELLATION","PARTIAL_DEFEASANCE","PARTIAL_DEFEASANCE_CANCELLATION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION","PAY_IN_KIND","PAY_IN_KIND_CANCELLATION","PEAK_FRACTION_COMPENSATION","PEAK_ORDER_ADJUSTMENT","PLACE_OF_INCORPORATION","PLACE_OF_INCORPORATION_CANCELLATION","PRIORITY_ISSUE","PRIORITY_ISSUE_CANCELLATION","PUT_REDEMPTION","PUT_REDEMPTION_CANCELLATION","REDENOMINATION","REDENOMINATION_CANCELLATION","REMARKETING_AGREEMENT","REMARKETING_AGREEMENT_CANCELLATION","REPURCHASE_OFFER","REPURCHASE_OFFER_CANCELLATION","REVERSE_STOCK_SPLIT","REVERSE_STOCK_SPLIT_CANCELLATION","RIGHTS_ISSUE","RIGHTS_ISSUE_CANCELLATION","SCRIP_DIVIDEND","SCRIP_DIVIDEND_CANCELLATION","SEPA_DIRECT_DEBIT","SEPA_DIRECT_DEBIT_CHARGE_BACK","SHARES_PREMIUM_DIVIDEND","SHARES_PREMIUM_DIVIDEND_CANCELLATION","SMALLEST_NEGOTIABLE_UNIT","SMALLEST_NEGOTIABLE_UNIT_CANCELLATION","SPIN_OFF","SPIN_OFF_CANCELLATION","STOCK_DIVIDEND","STOCK_DIVIDEND_CANCELLATION","STOCK_SPLIT","STOCK_SPLIT_CANCELLATION","TAX_ON_NON_DISTRIBUTED_PROCEEDS","TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION","TAX_PAYMENT","TAX_PREPAYMENT_DE","TAX_RECLAIM","TAX_RECLAIM_CANCELLATION","TAX_REFUND","TENDER","TENDER_CANCELLATION","TOPUP","TOPUP_CANCELLATION","TRADING_STATUS_ACTIVE","TRADING_STATUS_ACTIVE_CANCELLATION","TRADING_STATUS_DELISTED","TRADING_STATUS_DELISTED_CANCELLATION","TRADING_STATUS_SUSPENDED","TRADING_STATUS_SUSPENDED_CANCELLATION","TREASURY_PAYMENT","VIRTUAL_CASH_CORRECTION","VIRTUAL_CASH_CORRECTION_CANCELLATION","VIRTUAL_CASH_DECREASE","VIRTUAL_CASH_INCREASE","WARRANT_EXERCISE","WARRANT_EXERCISE_CANCELLATION","WITHDRAWAL","WITHDRAWAL_CANCELLATION","WORTHLESS","WORTHLESS_CANCELLATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION"]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"value_date":{"title":"Transaction value date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction value date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"}},"required":["id","type","account_group_id","delta","taxes","taxes_details","references","booking_date","value_date","created_at","updated_at"],"additionalProperties":true},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1146"},"schema_1147":{"kind":"json-schema","data":{"title":"Webhook - Security Transactions - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["SECURITY_TRANSACTION.EXECUTED"],"default":"SECURITY_TRANSACTION.EXECUTED"},"object":{"title":"Security Transaction","type":"object","properties":{"account_group_id":{"title":"Account group unique identifier.","type":"string","description":"Account group unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"booking_date":{"title":" Transaction booking date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction booking date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"delta":{"title":"Security transaction delta","description":"Entity representing the security transaction delta.","type":"object","properties":{"amount":{"type":"string","pattern":"^-?[0-9]{0,63}(\\.[0-9]{1,27})?$"}},"required":["amount"],"additionalProperties":true},"id":{"title":"Security transaction unique identifier","type":"string","description":"Security transaction unique identifier.","format":"uuid"},"instrument":{"title":"Instrument","description":"Entity representing instrument.","type":"object","properties":{"uuid":{"description":"Internal instrument identifier.","type":"string","format":"uuid"},"isin":{"title":"International securities identification number","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International securities identification number defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Securities_Identification_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 6166"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"}},"required":["uuid"],"additionalProperties":false},"type":{"title":"Transaction type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION - Accumulation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCUMULATION_CANCELLATION - Accumulation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING - Annual general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT - Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATTACHMENT_CANCELLATION - Attachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION - Balance correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY - Bankruptcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANKRUPTCY_CANCELLATION - Bankruptcy cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT - Bond default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_DEFAULT_CANCELLATION - Bond default cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING - Bond holder meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE - Bonus Issue/Capitalisation Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION - Capital distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION - Capitalisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAPITALISATION_CANCELLATION - Capitalisation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND - Cash dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE - Change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGE_CANCELLATION - Change, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION - Class action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLASS_ACTION_CANCELLATION - Class action cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION - Company option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPANY_OPTION_CANCELLATION - Company option cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT - Consent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSENT_CANCELLATION - Consent cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION - Conversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSION_CANCELLATION - Conversion cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING - Court meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COURT_MEETING_CANCELLATION - Court meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT - Credit event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREDIT_EVENT_CANCELLATION - Credit event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE - Decrease in value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECREASE_IN_VALUE_CANCELLATION - Decrease in value cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT - Detachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DETACHMENT_CANCELLATION - Detachment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE - Disclosure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISCLOSURE_CANCELLATION - Disclosure cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION - Dividend Option"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT - Dividend Reinvestment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING - Drawing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DRAWING_CANCELLATION - Drawing cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUST_CLEANUP - Dust Cleanup"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION - Dutch Auction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE - Exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXCHANGE_CANCELLATION - Exchange cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY - Final maturity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINAL_MATURITY_CANCELLATION - Final maturity cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL - Full call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FULL_CALL_CANCELLATION - Full call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE - Increase in value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREASE_IN_VALUE_CANCELLATION - Increase in value cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION - Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFORMATION_CANCELLATION - Information cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL - Instalment call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSTALMENT_CALL_CANCELLATION - Instalment call cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT - Interest payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION - Maturity extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER - Merger"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGER_CANCELLATION - Merger, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER - Non-Official Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE - Odd Lot Sale/Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION_CANCELLATION - Order execution cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING - Ordinary general meeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT - Other Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER_EVENT_CANCELLATION - Other Event cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU - Pari passu"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARI_PASSU_CANCELLATION - Pari passu cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE - Partial defeasance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND - Pay in kind"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAY_IN_KIND_CANCELLATION - Pay in kind cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_FRACTION_COMPENSATION - Peak fraction compensation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEAK_ORDER_ADJUSTMENT - Peak order adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION - Place of incorporation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE - Priority Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION - Put redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT_REDEMPTION_CANCELLATION - Put redemption cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION - Redenomination"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REDENOMINATION_CANCELLATION - Redenomination cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT - Remarketing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND - Scrip dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER - Securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_TRANSFER_CANCELLATION - Securities transfer cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND - Shares premium dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares premium dividend cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF - Spin-Off"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_OFF_CANCELLATION - Spin-Off, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND - Stock Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM - Tax reclaim"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER - Tender/Acquisition/Takeover/Purchase Offer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE - Trading status active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED - Trading status delisted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED - Trading status suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE - Warrant exercise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS - Worthless"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORTHLESS_CANCELLATION - Worthless, Cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECURITIES_LENDING - Securities lending"},"children":[]}]}]}]}],"type":"string","enum":["ACCUMULATION","ACCUMULATION_CANCELLATION","ANNUAL_GENERAL_MEETING","ANNUAL_GENERAL_MEETING_CANCELLATION","ATTACHMENT","ATTACHMENT_CANCELLATION","BALANCE_CORRECTION","BALANCE_CORRECTION_CANCELLATION","BANKRUPTCY","BANKRUPTCY_CANCELLATION","BOND_DEFAULT","BOND_DEFAULT_CANCELLATION","BOND_HOLDER_MEETING","BOND_HOLDER_MEETING_CANCELLATION","BONUS_ISSUE","BONUS_ISSUE_CANCELLATION","CALL_ON_INTERMEDIATE_SECURITIES","CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION","CAPITAL_DISTRIBUTION","CAPITAL_DISTRIBUTION_CANCELLATION","CAPITAL_GAINS_DISTRIBUTION","CAPITAL_GAINS_DISTRIBUTION_CANCELLATION","CAPITALISATION","CAPITALISATION_CANCELLATION","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES","CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION","CASH_DIVIDEND","CASH_DIVIDEND_CANCELLATION","CHANGE","CHANGE_CANCELLATION","CLASS_ACTION","CLASS_ACTION_CANCELLATION","COMPANY_OPTION","COMPANY_OPTION_CANCELLATION","CONSENT","CONSENT_CANCELLATION","CONVERSION","CONVERSION_CANCELLATION","COURT_MEETING","COURT_MEETING_CANCELLATION","CREDIT_EVENT","CREDIT_EVENT_CANCELLATION","DECREASE_IN_VALUE","DECREASE_IN_VALUE_CANCELLATION","DETACHMENT","DETACHMENT_CANCELLATION","DISCLOSURE","DISCLOSURE_CANCELLATION","DIVIDEND_OPTION","DIVIDEND_OPTION_CANCELLATION","DIVIDEND_REINVESTMENT","DIVIDEND_REINVESTMENT_CANCELLATION","DRAWING","DRAWING_CANCELLATION","DUST_CLEANUP","DUTCH_AUCTION","DUTCH_AUCTION_CANCELLATION","EXCHANGE","EXCHANGE_CANCELLATION","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING","EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION","FINAL_MATURITY","FINAL_MATURITY_CANCELLATION","FULL_CALL","FULL_CALL_CANCELLATION","INCREASE_IN_VALUE","INCREASE_IN_VALUE_CANCELLATION","INFORMATION","INFORMATION_CANCELLATION","INSTALMENT_CALL","INSTALMENT_CALL_CANCELLATION","INTEREST_PAYMENT","INTEREST_PAYMENT_CANCELLATION","INTERMEDIATE_SECURITIES_DISTRIBUTION","INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION","LIQUIDATION_PAYMENT","LIQUIDATION_PAYMENT_CANCELLATION","MATURITY_EXTENSION","MATURITY_EXTENSION_CANCELLATION","MERGER","MERGER_CANCELLATION","NON_OFFICIAL_OFFER","NON_OFFICIAL_OFFER_CANCELLATION","NON_US_TEFRA_D_CERTIFICATION","NON_US_TEFRA_D_CERTIFICATION_CANCELLATION","ODD_LOT_SALE","ODD_LOT_SALE_CANCELLATION","ORDER_EXECUTION","ORDER_EXECUTION_CANCELLATION","ORDINARY_GENERAL_MEETING","ORDINARY_GENERAL_MEETING_CANCELLATION","OTHER_EVENT","OTHER_EVENT_CANCELLATION","PARI_PASSU","PARI_PASSU_CANCELLATION","PARTIAL_DEFEASANCE","PARTIAL_DEFEASANCE_CANCELLATION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION","PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION","PAY_IN_KIND","PAY_IN_KIND_CANCELLATION","PEAK_FRACTION_COMPENSATION","PEAK_ORDER_ADJUSTMENT","PLACE_OF_INCORPORATION","PLACE_OF_INCORPORATION_CANCELLATION","PRIORITY_ISSUE","PRIORITY_ISSUE_CANCELLATION","PUT_REDEMPTION","PUT_REDEMPTION_CANCELLATION","REDENOMINATION","REDENOMINATION_CANCELLATION","REMARKETING_AGREEMENT","REMARKETING_AGREEMENT_CANCELLATION","REPURCHASE_OFFER","REPURCHASE_OFFER_CANCELLATION","REVERSE_STOCK_SPLIT","REVERSE_STOCK_SPLIT_CANCELLATION","RIGHTS_ISSUE","RIGHTS_ISSUE_CANCELLATION","SCRIP_DIVIDEND","SCRIP_DIVIDEND_CANCELLATION","SECURITIES_TRANSFER","SECURITIES_TRANSFER_CANCELLATION","SHARES_PREMIUM_DIVIDEND","SHARES_PREMIUM_DIVIDEND_CANCELLATION","SMALLEST_NEGOTIABLE_UNIT","SMALLEST_NEGOTIABLE_UNIT_CANCELLATION","SPIN_OFF","SPIN_OFF_CANCELLATION","STOCK_DIVIDEND","STOCK_DIVIDEND_CANCELLATION","STOCK_SPLIT","STOCK_SPLIT_CANCELLATION","TAX_ON_NON_DISTRIBUTED_PROCEEDS","TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION","TAX_RECLAIM","TAX_RECLAIM_CANCELLATION","TENDER","TENDER_CANCELLATION","TRADING_STATUS_ACTIVE","TRADING_STATUS_ACTIVE_CANCELLATION","TRADING_STATUS_DELISTED","TRADING_STATUS_DELISTED_CANCELLATION","TRADING_STATUS_SUSPENDED","TRADING_STATUS_SUSPENDED_CANCELLATION","VIRTUAL_CASH_CORRECTION_CANCELLATION","WARRANT_EXERCISE","WARRANT_EXERCISE_CANCELLATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION","WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION","WORTHLESS","WORTHLESS_CANCELLATION","SECURITIES_LENDING"]},"references":{"type":"array","items":{"title":"Security transaction reference","description":"Entity representing security transaction reference.","type":"object","properties":{"id":{"title":"Unique identifier for a resource of given type","type":"string","description":"Unique identifier for a resource of given type.","format":"uuid"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER - Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER_EXECUTION - Order execution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION - Corporate action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction ID"},"children":[]}]}]}]}],"enum":["ORDER","ORDER_EXECUTION","CORPORATE_ACTION","CORPORATE_ACTION_TRANSACTION_ID"]}},"required":["id","type"],"additionalProperties":false}},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"value_date":{"title":"Transaction value date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction value date and time. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}],"format":"date-time"}},"required":["id","type","account_id","account_group_id","instrument","delta","references","value_date","booking_date","created_at","updated_at"],"additionalProperties":true},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1147"},"schema_1148":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-z0-9-_\\.]{1,32}$","example":"booking_references"},"id":"schema_1148"},"schema_1149":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-z0-9-_\\.]{1,255}$","example":"list.txt"},"id":"schema_1149"},"schema_1150":{"kind":"json-schema","data":{"type":"string","default":0},"id":"schema_1150"},"schema_1151":{"kind":"json-schema","data":{"title":"Files metadata","type":"object","additionalProperties":false,"properties":{"id":{"title":"Metadata ID","type":"string","description":"Files metadata identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"signed_url":{"type":"string","format":"url","maxLength":1000,"description":"Files download URL."},"file_name":{"type":"string","pattern":"^[a-z0-9-_\\.]{1,32}$","description":"Name of the file."},"content_length":{"type":"integer","description":"Length of the file"},"checksum":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"CRC32 of the files content"}},"required":["id","created_at","updated_at","file_name","signed_url","content_length","checksum"]},"id":"schema_1151"},"schema_1152":{"kind":"json-schema","data":{"title":"Transfers - Account Transfer - Create - Request","type":"object","properties":{"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - Securities transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_OWNER_CHANGE - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the account transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This reference will be set and be common to all securities transfers"},"children":[]}]}]}]}]},"instruments":{"type":"array","items":{"title":"Instruments request","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of instrument to move in or out. The value supported is maximum 15 digits including decimal place."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the end user ensures that they don't sell their instruments on the counter-broker to enable smooth transfer of their instruments on Upvest platform."},"children":[]}]}]}]}]}},"required":["id","id_type","quantity"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at least one instrument should be defined. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTGOING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an empty list means full transfer of full units of the account."},"children":[]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for account transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Account transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for account transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"trade_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional forecast date when the trade takes place. If provided, usually T+1 is sufficient. Depending on the market this means valid working days. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: Each individual transfer can differ based on market needs."},"children":[]}]}]}]}]},"settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional forecast date when the settlement takes place. If provided, usually T+2 is sufficient or trade_date + 1. Depending on the market this means valid working days. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*NOTE: Each individual transfer can differ based on market needs."},"children":[]}]}]}]},"order_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional date when the transfer request was received from the end user. If omitted, Upvest defaults "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the transfer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"children":[]}]}]}]}},"required":["direction","user_id","account_id","transfer_type","settlement_reference","instruments","counterparty"],"additionalProperties":false},"id":"schema_1152"},"schema_1153":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Account transfer request unique identifier.","type":"string","description":"Account transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING - account transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - account transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - account transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - account transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - account transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIALLY_SETTLED - account transfer was partially settled, while some instrument got cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - account transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","PARTIALLY_SETTLED","CANCELLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_OWNER_CHANGE - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"instruments":{"title":"Instruments","type":"array","description":"List of instruments positions.","items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instrument to move in or out."},"quantity_settled":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instruments settled."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","CANCELLED"]},"transfer_id":{"type":"string","description":"Securities transfer request unique identifier.","format":"uuid"}},"required":["id","id_type","quantity","status","transfer_id"]}},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the account transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This reference will be set and be common to all securities transfers."},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for account transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Account transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for account transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"trade_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The forecast date when the trade takes place. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs."},"children":[]}]}]}]}]},"settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The forecast date when the settlement takes place. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs."},"children":[]}]}]}]}]},"order_date":{"type":"string","format":"date","description":"Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"delay_reason":{"title":"Delay reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorised reason why a securities transfer is delayed past the regulatory deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_INSTRUCTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty has not yet instructed the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_RESPONDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty does not agree to the delivery details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_ACCEPTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not accepting the transfer."},"children":[]}]}]}]}],"type":"string","enum":["COUNTERPARTY_NOT_INSTRUCTING","COUNTERPARTY_NOT_RESPONDING","COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS","COUNTERPARTY_NOT_ACCEPTING"]}},"required":["id","created_at","updated_at","direction","status","transfer_type","instruments","user_id","account_id","settlement_reference","counterparty"],"additionalProperties":false},"id":"schema_1153"},"schema_1154":{"kind":"json-schema","data":{"title":"Account transfer request unique identifier.","type":"string","description":"Account transfer request unique identifier.","format":"uuid"},"id":"schema_1154"},"schema_1155":{"kind":"json-schema","data":{"title":"Webhook - Account Transfer - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["ACCOUNT_TRANSFER.NEW","ACCOUNT_TRANSFER.PROCESSING","ACCOUNT_TRANSFER.SETTLED","ACCOUNT_TRANSFER.PARTIALLY_SETTLED","ACCOUNT_TRANSFER.CANCELLED"]},"object":{"type":"object","properties":{"id":{"title":"Account transfer request unique identifier.","type":"string","description":"Account transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCOMING - account transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OUTGOING - account transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - account transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - account transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLED - account transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIALLY_SETTLED - account transfer was partially settled, while some instrument got cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - account transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","PARTIALLY_SETTLED","CANCELLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_OWNER_CHANGE - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"instruments":{"title":"Instruments","type":"array","description":"List of instruments positions.","items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instrument to move in or out."},"quantity_settled":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instruments settled."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","CANCELLED"]},"transfer_id":{"type":"string","description":"Securities transfer request unique identifier.","format":"uuid"}},"required":["id","id_type","quantity","status","transfer_id"]}},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the account transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This reference will be set and be common to all securities transfers."},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for account transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Account transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for account transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"trade_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The forecast date when the trade takes place. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs."},"children":[]}]}]}]}]},"settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The forecast date when the settlement takes place. Date in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs."},"children":[]}]}]}]}]},"order_date":{"type":"string","format":"date","description":"Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"delay_reason":{"title":"Delay reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorised reason why a securities transfer is delayed past the regulatory deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_INSTRUCTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty has not yet instructed the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_RESPONDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty does not agree to the delivery details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_ACCEPTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not accepting the transfer."},"children":[]}]}]}]}],"type":"string","enum":["COUNTERPARTY_NOT_INSTRUCTING","COUNTERPARTY_NOT_RESPONDING","COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS","COUNTERPARTY_NOT_ACCEPTING"]}},"required":["id","created_at","updated_at","direction","status","transfer_type","instruments","user_id","account_id","settlement_reference","counterparty"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1155"},"schema_1156":{"kind":"json-schema","data":{"type":"string","enum":["INCOMING","OUTGOING"]},"id":"schema_1156"},"schema_1157":{"kind":"json-schema","data":{"type":"string","enum":["NEW","PROCESSING","CANCELLED","SETTLED"]},"id":"schema_1157"},"schema_1158":{"kind":"json-schema","data":{"title":"Security Transfers - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Securities transfer request unique identifier.","type":"string","description":"Securities transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTGOING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","CANCELLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_OWNER_CHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instrument to move in or out."},"quantity_settled":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instruments settled."},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"place_of_settlement":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!"},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for securities transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Securities transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for securities transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"settlement_counterparties":{"title":"Settlement Counterparties","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement counterparties for the securities transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_counterparties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Other participants are optional but must respect the following dependency rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided without an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field at transfer level serves as the settlement party."},"children":[]}]}]}],"type":"object","properties":{"settlement_agent":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_custodian":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_1":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_2":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_party":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false}},"required":["settlement_agent"],"additionalProperties":false},"trade_date":{"type":"string","format":"date","description":"The forecast date when the trade takes place. Date in YYYY-MM-DD format."},"settlement_date":{"type":"string","format":"date","description":"The forecast date when the settlement takes place. Date in YYYY-MM-DD format."},"actual_settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the transfer settled, only known in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Date in YYYY-MM-DD format."},"children":[]}]}]}]},"order_date":{"type":"string","format":"date","description":"Optional. Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"delay_reason":{"title":"Delay reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorised reason why a securities transfer is delayed past the regulatory deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_INSTRUCTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty has not yet instructed the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_RESPONDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty does not agree to the delivery details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_ACCEPTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not accepting the transfer."},"children":[]}]}]}]}],"type":"string","enum":["COUNTERPARTY_NOT_INSTRUCTING","COUNTERPARTY_NOT_RESPONDING","COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS","COUNTERPARTY_NOT_ACCEPTING"]}},"required":["id","created_at","updated_at","user_id","account_id","direction","status","transfer_type","instrument_id","instrument_id_type","quantity","counterparty","settlement_reference","trade_date","settlement_date"],"additionalProperties":false}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1158"},"schema_1159":{"kind":"json-schema","data":{"title":"Transfers - Securities Transfer - Create - Request","type":"object","properties":{"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTGOING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of instrument to move in or out. The value supported is maximum 15 digits including decimal place."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the end user ensures that they don't sell their instruments on the counter-broker to enable smooth transfer of their instruments on Upvest platform."},"children":[]}]}]}]}]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_OWNER_CHANGE - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"place_of_settlement":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIP: For non-live environment if you prefix the reference with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your transfer gets through all lifecycle states."},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for securities transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Securities transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for securities transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"settlement_counterparties":{"title":"Settlement Counterparties","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement counterparties for the securities transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_counterparties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Other participants are optional but must respect the following dependency rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided without an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field at transfer level serves as the settlement party."},"children":[]}]}]}],"type":"object","properties":{"settlement_agent":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_custodian":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_1":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_2":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_party":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false}},"required":["settlement_agent"],"additionalProperties":false},"trade_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional forecast date when the trade takes place. If provided, usually T+1 is sufficient. Depending on the market this means valid working days. Date in YYYY-MM-DD format."},"children":[]}]}]}]},"settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional forecast date when the settlement takes place. If provided, usually T+2 is sufficient or trade_date + 1. Depending on the market this means valid working days. Date in YYYY-MM-DD format."},"children":[]}]}]}]},"order_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional date when the transfer request was received from the end user. If omitted, Upvest defaults "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the transfer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"children":[]}]}]}]}},"required":["direction","user_id","account_id","instrument_id","instrument_id_type","quantity","transfer_type","settlement_reference","counterparty"],"additionalProperties":false},"id":"schema_1159"},"schema_1160":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"title":"Securities transfer request unique identifier.","type":"string","description":"Securities transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTGOING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","CANCELLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_OWNER_CHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instrument to move in or out."},"quantity_settled":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instruments settled."},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"place_of_settlement":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!"},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for securities transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Securities transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for securities transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"settlement_counterparties":{"title":"Settlement Counterparties","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement counterparties for the securities transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_counterparties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Other participants are optional but must respect the following dependency rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided without an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field at transfer level serves as the settlement party."},"children":[]}]}]}],"type":"object","properties":{"settlement_agent":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_custodian":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_1":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_2":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_party":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false}},"required":["settlement_agent"],"additionalProperties":false},"trade_date":{"type":"string","format":"date","description":"The forecast date when the trade takes place. Date in YYYY-MM-DD format."},"settlement_date":{"type":"string","format":"date","description":"The forecast date when the settlement takes place. Date in YYYY-MM-DD format."},"actual_settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the transfer settled, only known in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Date in YYYY-MM-DD format."},"children":[]}]}]}]},"order_date":{"type":"string","format":"date","description":"Optional. Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"delay_reason":{"title":"Delay reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorised reason why a securities transfer is delayed past the regulatory deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_INSTRUCTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty has not yet instructed the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_RESPONDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty does not agree to the delivery details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_ACCEPTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not accepting the transfer."},"children":[]}]}]}]}],"type":"string","enum":["COUNTERPARTY_NOT_INSTRUCTING","COUNTERPARTY_NOT_RESPONDING","COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS","COUNTERPARTY_NOT_ACCEPTING"]}},"required":["id","created_at","updated_at","user_id","account_id","direction","status","transfer_type","instrument_id","instrument_id_type","quantity","counterparty","settlement_reference","trade_date","settlement_date"],"additionalProperties":false},"id":"schema_1160"},"schema_1161":{"kind":"json-schema","data":{"title":"Webhook - Securities Transfers - Callback","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event unique identifier"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the event was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"type":{"type":"string","description":"Event type","enum":["SECURITIES_TRANSFER.NEW","SECURITIES_TRANSFER.PROCESSING","SECURITIES_TRANSFER.SETTLED","SECURITIES_TRANSFER.CANCELLED","SECURITIES_TRANSFER.DATA_CHANGED"]},"object":{"type":"object","properties":{"id":{"title":"Securities transfer request unique identifier.","type":"string","description":"Securities transfer request unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"direction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is incoming to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTGOING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is outgoing from the user."},"children":[]}]}]}]}],"enum":["INCOMING","OUTGOING"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is created but not started processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer is in processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was successfully settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Securities transfer was cancelled."},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","SETTLED","CANCELLED"]},"transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the securities transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_OWNER_CHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No change of ownership."},"children":[]}]}]}]}],"enum":["NO_OWNER_CHANGE"]},"instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other identity (depends on instrument_id_type) of the security to be transferred."},"children":[]}]}]}]},"instrument_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the instrument_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - International Securities Identification Number"},"children":[]}]}]}]}],"enum":["ISIN"]},"quantity":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instrument to move in or out."},"quantity_settled":{"type":"string","pattern":"^[0-9]{0,63}(\\.[0-9]{1,27})?$","description":"The quantity of instruments settled."},"user_id":{"title":"User unique identifier.","type":"string","description":"User unique identifier.","format":"uuid"},"account_id":{"title":"Account unique identifier.","type":"string","description":"Account unique identifier.","format":"uuid"},"place_of_settlement":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"settlement_reference":{"type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!"},"children":[]}]}]}]}]},"counterparty":{"title":"Counterparty","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for securities transfer. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which counterparty variant is present in the payload."},"children":[]}]}]}],"oneOf":[{"type":"object","title":"Securities transfer counterparty - BIC","description":"Counterparty with BIC (Bank Identifier Code) based identification for securities transfer.","properties":{"type":{"default":"BIC","type":"string","description":"Type of the counterparty."},"id":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"account_number":{"title":"Account Number","description":"The account number is composed of valid Swift charset with a max length of 28 if provided. The account number helps other brokers identify the owner of the assets.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,28}$"},"name":{"title":"Full name of the counterparty","description":"The name is going to be split into 4 lines of 35 characters, the split is space based. This means that even if the name is exactly 140 of length, we may drop out the last parts if they don't fit into 4x35.","type":"string","pattern":"^[0-9A-Za-z+?/\\-:()\\.,' ]{0,140}$"}},"required":["type","id"],"additionalProperties":false}]},"settlement_counterparties":{"title":"Settlement Counterparties","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement counterparties for the securities transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_counterparties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Other participants are optional but must respect the following dependency rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" presence requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_intermediary_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_custodian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided without an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field at transfer level serves as the settlement party."},"children":[]}]}]}],"type":"object","properties":{"settlement_agent":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_custodian":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_1":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_intermediary_2":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false},"settlement_party":{"title":"Settlement Counterparty","description":"A participant in the settlement chain, identified by an identification and an optional account.","type":"object","properties":{"identification":{"title":"Settlement Counterparty Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Party identified by name and address."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by BIC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by a proprietary code under a Data Source Scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Party identified by name and address."},"children":[]}]}]}]}],"enum":["BIC","PROPRIETARY","NAME_AND_ADDRESS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification value. The format depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid BIC code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A proprietary identifier under the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Name and address of the party."},"children":[]}]}]}]}]},"scheme":{"type":"string","pattern":"^[A-Z]{1,8}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Data Source Scheme code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROPRIETARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies the source of the proprietary identification (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAKV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CEDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"required":["type","value"],"additionalProperties":false},"account":{"title":"Settlement Counterparty Account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account of a settlement counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Safekeeping account."},"children":[]}]}]}]}],"enum":["SAFE"]},"value":{"type":"string","description":"Account identifier value."}},"required":["type","value"],"additionalProperties":false}},"required":["identification"],"additionalProperties":false}},"required":["settlement_agent"],"additionalProperties":false},"trade_date":{"type":"string","format":"date","description":"The forecast date when the trade takes place. Date in YYYY-MM-DD format."},"settlement_date":{"type":"string","format":"date","description":"The forecast date when the settlement takes place. Date in YYYY-MM-DD format."},"actual_settlement_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the transfer settled, only known in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Date in YYYY-MM-DD format."},"children":[]}]}]}]},"order_date":{"type":"string","format":"date","description":"Optional. Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format."},"delay_reason":{"title":"Delay reason code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorised reason why a securities transfer is delayed past the regulatory deadline."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_INSTRUCTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty has not yet instructed the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_RESPONDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty does not agree to the delivery details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTERPARTY_NOT_ACCEPTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The counterparty is not accepting the transfer."},"children":[]}]}]}]}],"type":"string","enum":["COUNTERPARTY_NOT_INSTRUCTING","COUNTERPARTY_NOT_RESPONDING","COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS","COUNTERPARTY_NOT_ACCEPTING"]}},"required":["id","created_at","updated_at","user_id","account_id","direction","status","transfer_type","instrument_id","instrument_id_type","quantity","counterparty","settlement_reference","trade_date","settlement_date"],"additionalProperties":false},"webhook_id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"}},"required":["id","created_at","type","object","webhook_id"],"additionalProperties":false},"id":"schema_1161"},"schema_1162":{"kind":"json-schema","data":{"title":"Auth - Verification keys","type":"object","description":"Webhooks verification keys.","properties":{"keys":{"type":"array","description":"List of verification keys","items":{"type":"object","properties":{"kid":{"type":"string","format":"uuid","description":"Key ID"},"kty":{"type":"string","enum":["EC"],"default":"EC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cryptographic algorithm family used with the key."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EC -"},"children":[]}]}]}]}]},"crv":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elliptic curve family."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P-521 -"},"children":[]}]}]}]}],"enum":["P-521"],"default":"P-521"},"x":{"type":"string","description":"Curve parameter"},"y":{"type":"string","description":"Curve parameter"}}}}},"required":["keys"],"additionalProperties":false},"id":"schema_1162"},"schema_1163":{"kind":"json-schema","data":{"type":"string","enum":["created_at","updated_at","title","url","enabled"],"default":"created_at"},"id":"schema_1163"},"schema_1164":{"kind":"json-schema","data":{"title":"Webhooks - List - Response","type":"object","properties":{"meta":{"type":"object","properties":{"offset":{"type":"integer","description":"Amount of resource to offset in the response."},"limit":{"type":"integer","description":"Total limit of the response."},"count":{"type":"integer","description":"Count of the resources returned in the response."},"total_count":{"type":"integer","description":"Total count of all the resources."},"sort":{"type":"string","description":"The field that the list is sorted by."},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ordering of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC - Ascending order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC - Descending order"},"children":[]}]}]}]}],"enum":["ASC","DESC"]}},"required":["offset","limit","count","total_count"]},"data":{"type":"array","items":{"title":"Webhook","type":"object","additionalProperties":false,"properties":{"id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"title":{"type":"string","pattern":"^[a-zA-Z0-9 ()\\[\\]{}.-]{1,32}$","description":"Title of the webhook for use on tenant side."},"url":{"type":"string","format":"url","maxLength":1000,"description":"The callback URL to be called by the webhook."},"enabled":{"type":"boolean","description":"Enable/disable webhook."},"type":{"type":"array","description":"What kind of events to be sent by the webhook.","default":["ALL"],"items":{"type":"string","enum":["ALL","BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"exclude_type":{"type":"array","description":"What kind of events to be excluded if subscription type is: ALL.","items":{"type":"string","enum":["BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"config":{"type":"object","description":"Configuration of webhook packages collection.","properties":{"delay":{"type":"string","pattern":"^([1-9]|[12][0-9]|30)s$","description":"Maximum time of package collection (1s-30s)."},"max_package_size":{"type":"integer","minimum":100,"maximum":1048576,"description":"Maximum package size (bytes)"}}}},"required":["id","created_at","updated_at","title","url","enabled","type","config"]}}},"required":["meta","data"],"additionalProperties":false},"id":"schema_1164"},"schema_1165":{"kind":"json-schema","data":{"title":"Webhook - Create - Request","type":"object","properties":{"title":{"type":"string","pattern":"^[a-zA-Z0-9 ()\\[\\]{}.-]{1,32}$","description":"Title of the webhook for use on tenant side."},"url":{"type":"string","format":"url","maxLength":1000,"description":"The callback URL to be called by the webhook."},"type":{"type":"array","description":"What kind of events to be sent by the webhook.","default":["ALL"],"items":{"type":"string","enum":["ALL","BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"exclude_type":{"type":"array","description":"What kind of events to be excluded if subscription type is: ALL.","items":{"type":"string","enum":["BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"config":{"type":"object","description":"Configuration of webhook packages collection.","properties":{"delay":{"type":"string","pattern":"^([1-9]|[12][0-9]|30)s$","description":"Maximum time of package collection (1s-30s)."},"max_package_size":{"type":"integer","minimum":100,"maximum":1048576,"description":"Maximum package size (bytes)"}}}},"required":["title","url"],"additionalProperties":false},"id":"schema_1165"},"schema_1166":{"kind":"json-schema","data":{"title":"Webhook","type":"object","additionalProperties":false,"properties":{"id":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was created. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the resource was last updated. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339-5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 UTC"},"children":[]}]}]}]}]},"title":{"type":"string","pattern":"^[a-zA-Z0-9 ()\\[\\]{}.-]{1,32}$","description":"Title of the webhook for use on tenant side."},"url":{"type":"string","format":"url","maxLength":1000,"description":"The callback URL to be called by the webhook."},"enabled":{"type":"boolean","description":"Enable/disable webhook."},"type":{"type":"array","description":"What kind of events to be sent by the webhook.","default":["ALL"],"items":{"type":"string","enum":["ALL","BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"exclude_type":{"type":"array","description":"What kind of events to be excluded if subscription type is: ALL.","items":{"type":"string","enum":["BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"config":{"type":"object","description":"Configuration of webhook packages collection.","properties":{"delay":{"type":"string","pattern":"^([1-9]|[12][0-9]|30)s$","description":"Maximum time of package collection (1s-30s)."},"max_package_size":{"type":"integer","minimum":100,"maximum":1048576,"description":"Maximum package size (bytes)"}}}},"required":["id","created_at","updated_at","title","url","enabled","type","config"]},"id":"schema_1166"},"schema_1167":{"kind":"json-schema","data":{"title":"Webhook ID","type":"string","description":"Webhook unique identifier.","format":"uuid"},"id":"schema_1167"},"schema_1168":{"kind":"json-schema","data":{"title":"Webhook - Update - Request","type":"object","properties":{"title":{"type":"string","pattern":"^[a-zA-Z0-9 ()\\[\\]{}.-]{1,32}$","description":"Title of the webhook for use on tenant side."},"url":{"type":"string","format":"url","maxLength":1000,"description":"The callback URL to be called by the webhook."},"enabled":{"type":"boolean","description":"Enable/disable webhook."},"type":{"type":"array","description":"What kind of events to be sent by the webhook.","default":["ALL"],"items":{"type":"string","enum":["ALL","BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"exclude_type":{"type":"array","description":"What kind of events to be excluded if subscription type is: ALL.","items":{"type":"string","enum":["BUSINESS","ROLE","USER","USER_CHECK","ORDER","ORDER_CANCELLATION","EXECUTION","POSITION","CASH_BALANCE","ACCOUNT","ACCOUNT_GROUP","INSTRUMENT","REPORT","TREASURY_REPORT","DIRECT_DEBIT","WITHDRAWAL","PORTFOLIO","PORTFOLIO_ALLOCATION","PORTFOLIO_ORDER","CORPORATE_ACTION","ACCOUNT_VALUATION","INTRADAY_ACCOUNT_VALUATION","CASH_TRANSACTION","SECURITY_TRANSACTION","ACCOUNT_LIQUIDATION","ACCOUNT_RETURNS","VIRTUAL_CASH_INCREASE","VIRTUAL_CASH_DECREASE","FEE_COLLECTION","SAVINGS_PLAN","SAVINGS_PLAN_EXECUTION","REBALANCING_EXECUTION_ORDER","TAX_EXEMPTION","TAX_COLLECTION","ISA_WRAPPER","ISA_WRAPPER_ALLOWANCE","CREDIT_FUNDING","VIRTUAL_BANK_ACCOUNT","SECURITIES_TRANSFER","ACCOUNT_TRANSFER","TOPUP","ISA_TRANSFER"]}},"config":{"type":"object","description":"Configuration of webhook packages collection.","properties":{"delay":{"type":"string","pattern":"^([1-9]|[12][0-9]|30)s$","description":"Maximum time of package collection (1s-30s)."},"max_package_size":{"type":"integer","minimum":100,"maximum":1048576,"description":"Maximum package size (bytes)"}}}},"additionalProperties":false},"id":"schema_1168"},"schema_1169":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string"},"response":{"type":"object","properties":{"status":{"type":"integer"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"body":{"type":"string"},"error":{"type":"string"}},"required":["status","headers","body"]}},"required":["url","response"]},"id":"schema_1169"},"schema_1170":{"kind":"json-schema","data":{"title":"Payments - Bank Transaction - Create - Request","type":"object","properties":{"account":{"allOf":[{"type":"object","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"}},"required":["iban"],"additionalProperties":false},{"description":"The Upvest account identification"}]},"amount":{"type":"string","pattern":"^[0-9]{1,9}(\\.[0-9]{2})?$"},"currency":{"title":"Bank transaction currency","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetic three-letter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code"},"children":[]}]}]}],"type":"string","enum":["EUR","GBP","USD","JPY","CHF"]},"remittance_information":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,140}$","description":"Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form."},"client_reference":{"type":"string","maxLength":35,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,35}$","description":"Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object."},"counterparty_name":{"type":"string","maxLength":140,"pattern":"^[0-9A-Za-z+?/\\-:()\\.,'; ]{0,140}$","description":"The counterparty account owner"},"counterparty_account":{"allOf":[{"type":"object","properties":{"iban":{"title":"International Bank Account Number (IBAN)","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Bank Account Number "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/International_Bank_Account_Number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$"}},"required":["iban"],"additionalProperties":false},{"description":"Unambiguous identification of the account of the counterparty of the bank transaction"}]},"counterparty_agent":{"allOf":[{"type":"object","properties":{"bic":{"title":"Business Identifier Code","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_9362"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 9362"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"required":["bic"],"additionalProperties":false},{"description":"Unambiguous identification of the agent of the counterparty of the bank transaction"}]},"virtual_bank_account_id":{"allOf":[{"title":"Virtual bank account request unique identifier.","type":"string","description":"Virtual bank account request unique identifier.","format":"uuid"},{"description":"The ID of the virtual bank account to which you want to send the money."}]},"purpose_code":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional parameter, which describes the purpose of the payment based on "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExternalPurpose1Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["account","amount","currency","client_reference","counterparty_name","counterparty_account"],"additionalProperties":false},"id":"schema_1170"},"schema_1171":{"kind":"json-schema","data":{"title":"Payments - Bank Transaction - Create - Response","type":"object","properties":{"id":{"title":"Bank transaction unique identifier","type":"string","description":"Bank transaction unique identifier","format":"uuid"},"bank_reference":{"type":"string","description":"Bank reference of the bank transaction (created by the bank to unambiguously identify the bank transaction in the banks systems)"}},"required":["id","bank_reference"]},"id":"schema_1171"}},"exampleStore":{"paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"client_id":"363f3305-7ab0-4e82-a158-f9d382ad08b6","client_secret":"WHIW1yic-ouct3sceh","grant_type":"client_credentials","scope":"users:read"},"id":"paths/~1auth~1token/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1auth~1token/post/responses/200/content/application~1json/example":{"value":{"access_token":"token.signature","expires_in":1800,"token_type":"bearer","scope":"users:read"},"id":"paths/~1auth~1token/post/responses/200/content/application~1json/example"},"paths/~1auth~1token/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1auth~1token/post/responses/400/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1auth~1token/post/responses/401/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1auth~1token/post/responses/403/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1auth~1token/post/responses/406/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1auth~1token/post/responses/429/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1auth~1token/post/responses/500/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1auth~1token/post/responses/503/content/application~1problem+json/example"},"paths/~1auth~1token/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1auth~1token/post/responses/504/content/application~1problem+json/example"},"paths/~1users/get/responses/200/content/application~1json/examples/BYOL":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE"},{"id":"287673ef-1bae-4d8a-9e78-8ddaae249d72","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"John","last_name":"Doe","email":"john.doe@example.com","salutation":"SALUTATION_MALE","title":"PROF_DR","birth_date":"1970-10-01","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":null,"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE"}]},"key":"BYOL","summary":"BYOL users","id":"paths/~1users/get/responses/200/content/application~1json/examples/BYOL"},"paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},{"id":"287673ef-1bae-4d8a-9e78-8ddaae249d72","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"John","last_name":"Doe","salutation":"SALUTATION_MALE","title":"PROF_DR","birth_date":"1970-10-01","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":null,"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"}]},"key":"BYOL With Branch ID","summary":"BYOL users with branch ID","id":"paths/~1users/get/responses/200/content/application~1json/examples/BYOL With Branch ID"},"paths/~1users/get/responses/200/content/application~1json/examples/TOL":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE"},{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":null,"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"a8a87268-4f3c-4de2-abb9-a553a3bb7608","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fb1827c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE"}]},"key":"TOL","summary":"TOL users","id":"paths/~1users/get/responses/200/content/application~1json/examples/TOL"},"paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"created_at","order":"ASC"},"data":[{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":null,"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"a8a87268-4f3c-4de2-abb9-a553a3bb7608","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fb1827c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"}]},"key":"TOL With Branch ID","summary":"TOL users with branch ID","id":"paths/~1users/get/responses/200/content/application~1json/examples/TOL With Branch ID"},"paths/~1users/get/responses/200/content/application~1json/examples/empty":{"value":{"meta":{"offset":0,"limit":100,"count":0,"total_count":0,"sort":"created_at","order":"ASC"},"data":[]},"key":"empty","summary":"Empty users list","id":"paths/~1users/get/responses/200/content/application~1json/examples/empty"},"paths/~1users/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users/get/responses/400/content/application~1problem+json/example"},"paths/~1users/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users/get/responses/401/content/application~1problem+json/example"},"paths/~1users/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users/get/responses/403/content/application~1problem+json/example"},"paths/~1users/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users/get/responses/406/content/application~1problem+json/example"},"paths/~1users/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users/get/responses/429/content/application~1problem+json/example"},"paths/~1users/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users/get/responses/500/content/application~1problem+json/example"},"paths/~1users/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users/get/responses/503/content/application~1problem+json/example"},"paths/~1users/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users/get/responses/504/content/application~1problem+json/example"},"paths/~1users/post/requestBody/content/application~1json/examples/BYOL":{"value":{"first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},"key":"BYOL","summary":"BYOL user","id":"paths/~1users/post/requestBody/content/application~1json/examples/BYOL"},"paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID":{"value":{"first_name":"Karl","last_name":"Schmidt","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"BYOL User with Branch ID","summary":"BYOL User with branch ID","id":"paths/~1users/post/requestBody/content/application~1json/examples/BYOL User with Branch ID"},"paths/~1users/post/requestBody/content/application~1json/examples/TOL":{"value":{"first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"}},"key":"TOL","summary":"TOL user","id":"paths/~1users/post/requestBody/content/application~1json/examples/TOL"},"paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID":{"value":{"first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"TOL User with Branch ID","summary":"TOL User with Branch ID","id":"paths/~1users/post/requestBody/content/application~1json/examples/TOL User with Branch ID"},"paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents":{"value":{"first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"}},"key":"TOL User without Consents","summary":"TOL user without consents","id":"paths/~1users/post/requestBody/content/application~1json/examples/TOL User without Consents"},"paths/~1users/post/responses/200/content/application~1json/examples/BYOL":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE"},"key":"BYOL","summary":"BYOL User","id":"paths/~1users/post/responses/200/content/application~1json/examples/BYOL"},"paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"BYOL with Branch ID","summary":"BYOL User with Branch ID","id":"paths/~1users/post/responses/200/content/application~1json/examples/BYOL with Branch ID"},"paths/~1users/post/responses/200/content/application~1json/examples/TOL":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE"},"key":"TOL","summary":"TOL User","id":"paths/~1users/post/responses/200/content/application~1json/examples/TOL"},"paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"TOL With Branch ID","summary":"TOL User with Branch ID","id":"paths/~1users/post/responses/200/content/application~1json/examples/TOL With Branch ID"},"paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"status":"ACTIVE"},"key":"TOL without Consents","summary":"TOL User without consents","id":"paths/~1users/post/responses/200/content/application~1json/examples/TOL without Consents"},"paths/~1users/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users/post/responses/400/content/application~1problem+json/example"},"paths/~1users/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users/post/responses/401/content/application~1problem+json/example"},"paths/~1users/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users/post/responses/403/content/application~1problem+json/example"},"paths/~1users/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users/post/responses/406/content/application~1problem+json/example"},"paths/~1users/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users/post/responses/429/content/application~1problem+json/example"},"paths/~1users/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users/post/responses/500/content/application~1problem+json/example"},"paths/~1users/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users/post/responses/503/content/application~1problem+json/example"},"paths/~1users/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users/post/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE"},"key":"BYOL","summary":"BYOL user","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"BYOL User with Branch ID","summary":"BYOL User with Branch ID","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/BYOL User with Branch ID"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE"},"key":"TOL","summary":"TOL user","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"terms_and_conditions":{"consent_document_id":"d0b83880-3809-4eee-b0df-ca50db84c15a","confirmed_at":"2020-08-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec","confirmed_at":"2020-08-24T14:16:22Z"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"TOL User with Branch ID","summary":"TOL User with Branch ID","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User with Branch ID"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"DR","birth_date":"1972-09-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"phone_number":"4930901820","postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"fatca":{"status":false,"confirmed_at":"2020-08-24T14:15:22Z"},"status":"ACTIVE"},"key":"TOL User without Consents","summary":"TOL user without consents","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/TOL User without Consents"},"paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name":{"value":{"first_name":"Karl","last_name":"Schmidt","issuance_date":"2030-01-01","data_download_link":"https://bucket.customer.com/ident/user3.zip","document_type":"ID_CARD"},"key":"Name","summary":"Name","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Name"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email":{"value":{"email":"max@example.com"},"key":"TOL User Email","summary":"Email","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Email"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality":{"value":{"nationalities":["DE"],"issuance_date":"2030-01-01","data_download_link":"https://bucket.customer.com/ident/user3.zip","document_type":"ID_CARD"},"key":"Nationality","summary":"Nationality","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Nationality"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address":{"value":{"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"issuance_date":"2020-01-01","data_download_link":"https://bucket.customer.com/por/user3.zip","document_type":"UTILITY_BILL"},"key":"Address","summary":"Address","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Address"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change":{"value":{"first_name":"Karl","last_name":"Schmidt","email":"karl.schmidt@example.com","salutation":"SALUTATION_MALE","title":"PROF_DR","birth_date":"1972-01-30","birth_city":"Berlin","birth_country":"DE","birth_name":"Schmidt","nationalities":["DE","AU"],"address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"postal_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"},"branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"BYOL User Data Change","summary":"BYOL User Data Change","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/BYOL User Data Change"},"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID":{"value":{"branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"key":"TOL User Data Change With Branch ID","summary":"Branch ID","id":"paths/~1users~1{user_id}~1data_change_requests/post/requestBody/content/application~1json/examples/TOL User Data Change With Branch ID"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"},"paths/Users events/post/requestBody/content/application~1json/examples/BYOL":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-19T13:06:51.980159529Z","type":"USER.CREATED","object":{"created_at":"2021-11-22T09:04:42Z","updated_at":"2021-11-22T09:04:42Z","first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","salutation":"SALUTATION_FEMALE","title":"PROF","birth_date":"1990-01-01","birth_city":"Berlin","birth_country":"DE","birth_name":"Smith","nationalities":["DE","CH"],"address":{"address_line1":"Torstrasse","address_line2":"12a","city":"Berlin","country":"DE","postcode":"10115","state":"BE"},"id":"a1752f00-93d5-4b77-a148-959cd315581b","postal_address":{"address_line1":"Thorstrasse","address_line2":"123","city":"Berlin","country":"DE","postcode":"10115","state":"BE"},"status":"ACTIVE","branch_id":"e6373bfa-ff12-4004-8de9-747ac96764da"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"BYOL","summary":"BYOL user event","id":"paths/Users events/post/requestBody/content/application~1json/examples/BYOL"},"paths/Users events/post/requestBody/content/application~1json/examples/TOL":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-22T09:04:42Z","type":"USER.CREATED","object":{"created_at":"2021-11-22T09:04:42Z","updated_at":"2021-11-22T09:04:42Z","first_name":"Jane","last_name":"Doe","salutation":"SALUTATION_FEMALE","title":"PROF","birth_date":"1990-01-01","birth_city":"Berlin","birth_country":"DE","birth_name":"Smith","nationalities":["DE","CH"],"address":{"address_line1":"Torstrasse","address_line2":"12a","city":"Berlin","country":"DE","postcode":"10115","state":"BE"},"id":"a1752f00-93d5-4b77-a148-959cd315581b","postal_address":{"address_line1":"Thorstrasse","address_line2":"123","city":"Berlin","country":"DE","postcode":"10115","state":"BE"},"status":"ACTIVE","data_privacy_and_sharing_agreement":{"confirmed_at":"2021-02-03T17:14:46Z","consent_document_id":"7ab0fc5c-8157-4acd-b02d-6ccda0e81dec"},"email":"janedoe@example.com","fatca":{"confirmed_at":"2020-02-03T17:14:46Z","status":false},"phone_number":"0123456789","terms_and_conditions":{"confirmed_at":"2020-02-03T17:14:46Z","consent_document_id":"62814307-f14b-40af-bc66-5942a549a759"},"branch_id":"a1752f00-93d5-4b77-a148-959cd315581b"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"TOL","summary":"TOL user event","id":"paths/Users events/post/requestBody/content/application~1json/examples/TOL"},"paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"NATIONAL_ID","issuing_country":"PL","identifier_standard":"PESEL","identifier":"83053078917"},{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be111","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"NATIONAL_ID","issuing_country":"DK","identifier_standard":"DPIC","identifier":"3005837891"},{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be303","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be505","type":"NATIONAL_ID","issuing_country":"DE","identifier_standard":"CONCAT","identifier":""},{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be303","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be505","type":"PASSPORT","issuing_country":"NL","identifier_standard":"NLPN","identifier":""}]},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1identifiers/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id":{"value":{"type":"NATIONAL_ID","issuing_country":"PL","identifier_standard":"PESEL","identifier":"83053078917"},"key":"national_id","summary":"National ID","id":"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/national_id"},"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport":{"value":{"type":"PASSPORT","issuing_country":"NL","identifier_standard":"NLPN","identifier":"AB12AB349"},"key":"passport","summary":"Passport","id":"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/passport"},"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat":{"value":{"type":"NATIONAL_ID","issuing_country":"DE","identifier_standard":"CONCAT"},"key":"concat","summary":"CONCAT (value generated by Upvest, identifier omitted)","id":"paths/~1users~1{user_id}~1identifiers/post/requestBody/content/application~1json/examples/concat"},"paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"NATIONAL_ID","issuing_country":"PL","identifier_standard":"PESEL","identifier":"83053078917"},"key":"national_id","summary":"National ID","id":"paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/national_id"},"paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"PASSPORT","issuing_country":"NL","identifier_standard":"NLPN","identifier":"83053078917"},"key":"passport","summary":"Passport","id":"paths/~1users~1{user_id}~1identifiers/post/responses/200/content/application~1json/examples/passport"},"paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1identifiers/post/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"NATIONAL_ID","issuing_country":"PL","identifier_standard":"PESEL","identifier":"83053078917"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example":{"value":{"identifier":"83053078111"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/requestBody/content/application~1json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example":{"value":{"id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-22T15:20:10.00Z","user_id":"00000ec2-d2ca-49ff-bbea-b92b5c3be203","type":"NATIONAL_ID","issuing_country":"PL","identifier_standard":"PESEL","identifier":"83053078111"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1identifiers~1{identifier_id}/patch/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"008a82d0-c5a4-4410-9318-d34786429c5a","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"KYC","check_confirmed_at":"2019-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/ident/user3.zip","document_type":"ID_CARD","document_expiration_date":"2030-01-01","nationality":"DE","status":"PASSED","provider":"KYC provider","method":"VIDEO_ID","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},{"id":"a680ff52-3a96-4e82-a2ab-12563bbd1a2e","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"INSTRUMENT_FIT","check_confirmed_at":"2020-08-24T14:15:22Z","status":"PASSED","instrument_suitability":{"suitability":true}},{"id":"b633a915-ed3c-43d7-afb5-a550f26ccb0d","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"POR","check_confirmed_at":"2020-08-24T14:15:22Z","issuance_date":"2020-01-01","data_download_link":"https: //bucket.customer.com/por/user3.zip","document_type":"UTILITY_BILL","status":"PASSED","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},{"id":"76aa72aa-3738-4640-bad5-68c1196dc758","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"COMPLIANCE","check_confirmed_at":"2020-08-24T14:15:22Z","status":"PASSED"},{"id":"d8f9e2c1-4a5b-4c6d-8e7f-9a0b1c2d3e4f","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"GUARDIAN","role_id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","document_type":"BIRTH_CERTIFICATE","data_download_link":"https://bucket.customer.com/guardian/birth_cert.pdf","status":"PASSED"}]},"id":"paths/~1users~1{user_id}~1checks/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1checks/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1checks/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1checks/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1checks/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1checks/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1checks/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1checks/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1checks/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1checks/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC":{"value":{"type":"KYC","check_confirmed_at":"2019-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/ident/user3.zip","document_type":"ID_CARD","document_expiration_date":"2030-01-01","nationality":"DE","provider":"KYC provider","method":"VIDEO_ID","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},"key":"KYC","summary":"KYC check","id":"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/KYC"},"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT":{"value":{"type":"INSTRUMENT_FIT","check_confirmed_at":"2020-08-24T14:15:22Z","instrument_suitability":{"suitability":true}},"key":"INSTRUMENT_FIT","summary":"Instrument fit check","id":"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/INSTRUMENT_FIT"},"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR":{"value":{"type":"POR","check_confirmed_at":"2020-08-24T14:15:22Z","issuance_date":"2020-01-01","data_download_link":"https://bucket.customer.com/por/user3.zip","document_type":"UTILITY_BILL","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},"key":"POR","summary":"PoR check","id":"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/POR"},"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN":{"value":{"type":"GUARDIAN","check_confirmed_at":"2020-08-24T14:15:22Z","role_id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","document_type":"BIRTH_CERTIFICATE","data_download_link":"https://bucket.customer.com/guardian/birth_cert.pdf"},"key":"GUARDIAN","summary":"Guardian check","id":"paths/~1users~1{user_id}~1checks/post/requestBody/content/application~1json/examples/GUARDIAN"},"paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example":{"value":{"id":"e13e9d81-7f43-492d-a02a-440edced389a"},"id":"paths/~1users~1{user_id}~1checks/post/responses/202/content/application~1json/example"},"paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1checks/post/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1checks/post/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1checks/post/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1checks/post/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1checks/post/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1checks/post/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1checks/post/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1checks/post/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1checks/post/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC":{"value":{"id":"008a82d0-c5a4-4410-9318-d34786429c5a","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"KYC","check_confirmed_at":"2019-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/ident/user3.zip","document_type":"ID_CARD","document_expiration_date":"2030-01-01","nationality":"DE","status":"PASSED","provider":"KYC provider","method":"VIDEO_ID","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},"key":"KYC","summary":"KYC user check","id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYC"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT":{"value":{"id":"a680ff52-3a96-4e82-a2ab-12563bbd1a2e","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"INSTRUMENT_FIT","check_confirmed_at":"2020-08-24T14:15:22Z","status":"PASSED","instrument_suitability":{"suitability":true}},"key":"INSTRUMENT_FIT","summary":"Instrument fit user check","id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/INSTRUMENT_FIT"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR":{"value":{"id":"b633a915-ed3c-43d7-afb5-a550f26ccb0d","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"POR","check_confirmed_at":"2020-08-24T14:15:22Z","issuance_date":"2020-01-01","data_download_link":"https://bucket.customer.com/por/user3.zip","document_type":"UTILITY_BILL","status":"PASSED","confirmed_address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","state":"BE","country":"DE"}},"key":"POR","summary":"POR user check","id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/POR"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE":{"value":{"id":"76aa72aa-3738-4640-bad5-68c1196dc758","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"COMPLIANCE","check_confirmed_at":"2020-08-24T14:15:22Z","status":"PASSED"},"key":"COMPLIANCE","summary":"Compliance user check","id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/COMPLIANCE"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN":{"value":{"id":"d8f9e2c1-4a5b-4c6d-8e7f-9a0b1c2d3e4f","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","type":"GUARDIAN","check_confirmed_at":"2020-08-24T14:15:22Z","role_id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","document_type":"BIRTH_CERTIFICATE","data_download_link":"https://bucket.customer.com/guardian/birth_cert.pdf","status":"PASSED"},"key":"GUARDIAN","summary":"Guardian user check","id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/GUARDIAN"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"},"paths/User checks events/post/requestBody/content/application~1json/example":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2021-11-19T13:06:57.820371265Z","type":"USER_CHECK.PASSED","object":{"check_confirmed_at":"2021-08-02T15:04:05Z","data_download_link":"https://storage.cloud.google.com/upvest-mock-documents/Test_KYC_documents.zip","document_expiration_date":"2028-01-02","document_type":"PASSPORT","id":"32cbb9a2-dd3b-4e60-a5af-9b41460049dc","user_id":"7b39529a-e68c-4688-8242-7549d10d6084","method":"VIDEO_ID","nationality":"RU","provider":"IDNOW","status":"PASSED","type":"KYC"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"id":"paths/User checks events/post/requestBody/content/application~1json/example"},"paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses":{"value":{"meta":{"offset":0,"limit":100,"count":0,"total_count":0,"sort":"created_at","order":"ASC"},"data":[{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2023-09-24T11:15:10Z","updated_at":"2023-09-24T11:15:10Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"LIMITED_LIABILITY_COMPANY","identification":{"company_name":"Acme Corporation","incorporation_date":"2000-01-01","district_court":"Berlin Charlottenburg","legal_designation":"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","legal_entity_identifier":"213800K98H63P249S632","common_reporting_standards":{"is_passive_non_financial_entity":false,"is_financial_institution":false}},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2023-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2023-10-24T14:16:22Z"},"status":"ACTIVE"}]},"key":"List Businesses","summary":"List of businesses","id":"paths/~1businesses/get/responses/200/content/application~1json/examples/List Businesses"},"paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List":{"value":{"meta":{"offset":0,"limit":100,"count":0,"total_count":0,"sort":"created_at","order":"ASC"},"data":[]},"key":"Empty List","summary":"Empty businesses list","id":"paths/~1businesses/get/responses/200/content/application~1json/examples/Empty List"},"paths/~1businesses/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses/post/requestBody/content/application~1json/examples/Company":{"value":{"contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"LIMITED_LIABILITY_COMPANY","identification":{"company_name":"Acme Corporation","incorporation_date":"2000-10-10","district_court":"Berlin Charlottenburg","legal_designation":"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","legal_entity_identifier":"213800K98H63P249S632","common_reporting_standards":{"is_passive_non_financial_entity":false,"is_financial_institution":false}},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"}},"key":"Company","summary":"Company business","id":"paths/~1businesses/post/requestBody/content/application~1json/examples/Company"},"paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader":{"value":{"contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"SOLE_TRADER","identification":{"company_name":"Max Mustermann - Web Design","incorporation_date":"2000-10-10","legal_designation":"EINZELUNTERNEHMER"},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"}},"key":"Sole Trader","summary":"Sole Trader business","id":"paths/~1businesses/post/requestBody/content/application~1json/examples/Sole Trader"},"paths/~1businesses/post/responses/200/content/application~1json/examples/Company":{"value":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"LIMITED_LIABILITY_COMPANY","identification":{"company_name":"Acme Corporation","incorporation_date":"2000-10-10","district_court":"Berlin Charlottenburg","legal_designation":"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","legal_entity_identifier":"213800K98H63P249S632","common_reporting_standards":{"is_passive_non_financial_entity":false,"is_financial_institution":false}},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"key":"Company","summary":"Company business","id":"paths/~1businesses/post/responses/200/content/application~1json/examples/Company"},"paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader":{"value":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"SOLE_TRADER","identification":{"company_name":"Max Mustermann - Web Design","incorporation_date":"2000-10-10","legal_designation":"EINZELUNTERNEHMER"},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"key":"Sole Trader","summary":"Sole Trader business","id":"paths/~1businesses/post/responses/200/content/application~1json/examples/Sole Trader"},"paths/~1businesses/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses/post/responses/400/content/application~1problem+json/example"},"paths/~1businesses/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses/post/responses/401/content/application~1problem+json/example"},"paths/~1businesses/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses/post/responses/403/content/application~1problem+json/example"},"paths/~1businesses/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses/post/responses/406/content/application~1problem+json/example"},"paths/~1businesses/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses/post/responses/429/content/application~1problem+json/example"},"paths/~1businesses/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses/post/responses/500/content/application~1problem+json/example"},"paths/~1businesses/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses/post/responses/503/content/application~1problem+json/example"},"paths/~1businesses/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses/post/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company":{"value":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"LIMITED_LIABILITY_COMPANY","identification":{"company_name":"Acme Corporation","incorporation_date":"2000-01-01","district_court":"Berlin Charlottenburg","legal_designation":"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","legal_entity_identifier":"213800K98H63P249S632","common_reporting_standards":{"is_passive_non_financial_entity":false,"is_financial_institution":false}},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"key":"Company","summary":"Company business","id":"paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Company"},"paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader":{"value":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"SOLE_TRADER","identification":{"company_name":"Max Mustermann - Web Design","incorporation_date":"2000-10-10","legal_designation":"EINZELUNTERNEHMER"},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"key":"Sole Trader","summary":"Sole Trader business","id":"paths/~1businesses~1{business_id}/get/responses/200/content/application~1json/examples/Sole Trader"},"paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email":{"value":{"contact_email":"acme.corporation@example.com"},"key":"Contact Email","summary":"Contact Email","id":"paths/~1businesses~1{business_id}~1data_change_requests/post/requestBody/content/application~1json/examples/Contact Email"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1data_change_requests/post/responses/504/content/application~1problem+json/example"},"paths/Business events/post/requestBody/content/application~1json/examples/Company":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-22T09:04:42Z","type":"BUSINESS.CREATED","object":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"LIMITED_LIABILITY_COMPANY","identification":{"company_name":"Acme Corporation","incorporation_date":"2000-10-10","district_court":"Berlin Charlottenburg","legal_designation":"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG","legal_entity_identifier":"213800K98H63P249S632","common_reporting_standards":{"is_passive_non_financial_entity":false,"is_financial_institution":false}},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"Company","summary":"Company business event","id":"paths/Business events/post/requestBody/content/application~1json/examples/Company"},"paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-22T09:04:42Z","type":"BUSINESS.CREATED","object":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","created_at":"2024-10-24T14:14:22Z","updated_at":"2024-10-24T14:14:22Z","contact_email":"acme.corporation@example.com","registered_address":{"address_line1":"110","address_line2":"Schonhauser Allee","postcode":"101110","city":"Berlin","state":"BE","country":"DE"},"registration_number":"111221111","tax_information":{"tax_country_code":"DE","tax_identification_type":"STEUERNUMMER","tax_identification_number":"12345678901","is_resident_in_multiple_tax_jurisdictions":false,"is_subject_to_fatca":false},"business_type":"SOLE_TRADER","identification":{"company_name":"Max Mustermann - Web Design","incorporation_date":"2000-10-10","legal_designation":"EINZELUNTERNEHMER"},"terms_and_conditions":{"consent_document_id":"6a163d14-5b3d-48be-ac90-43314e96be71","confirmed_at":"2024-10-24T14:14:22Z"},"data_privacy_and_sharing_agreement":{"consent_document_id":"fa2227c3-2b29-47e1-84da-996d09517edc","confirmed_at":"2024-10-24T14:16:22Z"},"status":"ACTIVE"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"Sole Trader","summary":"Sole Trader business event","id":"paths/Business events/post/requestBody/content/application~1json/examples/Sole Trader"},"paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"d3f8c9a1-4b2e-4c8e-9f3e-2a5b7e6d9c1f","business_id":"e7a1c2d4-5f6b-7a8e-9b0c-1d2e3f4a5b6c","type":"KYB","originally_confirmed_at":"2020-08-24T14:15:22Z","check_confirmed_at":"2020-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/por/kyb.zip","document_type":"KYB_DOCUMENTS","status":"PASSED"}]},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1checks/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB":{"value":{"type":"KYB","originally_confirmed_at":"2020-08-24T14:15:22Z","check_confirmed_at":"2024-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/por/kyb.zip"},"key":"KYB","summary":"KYB check","id":"paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/KYB"},"paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT":{"value":{"type":"BUSINESS_SELF_ASSESSMENT","check_confirmed_at":"2021-08-24T14:15:22Z","business_industry":"MANUFACTURING","purpose_of_business_relationship":"WEALTH_GROWTH","primary_countries_of_activity":["DE","FR"],"annual_revenue":{"currency":"EUR","lower_bound":0,"upper_bound":50000},"expected_volume_of_investment":{"currency":"EUR","lower_bound":0,"upper_bound":50000},"total_asset_value":{"currency":"EUR","lower_bound":0,"upper_bound":50000}},"key":"BUSINESS_SELF_ASSESSMENT","summary":"Business Self Assessment check","id":"paths/~1businesses~1{business_id}~1checks/post/requestBody/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"},"paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example":{"value":{"id":"e13e9d81-7f43-492d-a02a-440edced389a"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/202/content/application~1json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1checks/post/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB":{"value":{"id":"f3b2d9c6-8e4f-4a7b-9c2d-7a5e1f3c4d6e","business_id":"d4b5f9a7-8e2c-4c1d-9a3f-7b6e2d3c4f5a","type":"KYB","originally_confirmed_at":"2020-08-24T14:15:22Z","check_confirmed_at":"2024-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/por/kyb.zip","document_type":"KYB_DOCUMENTS","status":"IN_PROGRESS"},"key":"KYB","summary":"KYB check","id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/KYB"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT":{"value":{"id":"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d","business_id":"d4b5f9a7-8e2c-4c1d-9a3f-7b6e2d3c4f5a","type":"BUSINESS_SELF_ASSESSMENT","check_confirmed_at":"2021-08-24T14:15:22Z","status":"PASSED","business_industry":"MANUFACTURING","purpose_of_business_relationship":"WEALTH_GROWTH","primary_countries_of_activity":["DE","FR"],"annual_revenue":{"currency":"EUR","lower_bound":0,"upper_bound":50000},"expected_volume_of_investment":{"currency":"EUR","lower_bound":0,"upper_bound":50000},"total_asset_value":{"currency":"EUR","lower_bound":0,"upper_bound":50000}},"key":"BUSINESS_SELF_ASSESSMENT","summary":"Business Self Assessment check","id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/200/content/application~1json/examples/BUSINESS_SELF_ASSESSMENT"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1checks~1{check_id}/get/responses/504/content/application~1problem+json/example"},"paths/Business checks events/post/requestBody/content/application~1json/example":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2021-11-19T13:06:57.820371265Z","type":"BUSINESS_CHECK.PASSED","object":{"id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","business_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","type":"KYB","originally_confirmed_at":"2020-08-24T14:15:22Z","check_confirmed_at":"2020-08-24T14:15:22Z","data_download_link":"https://bucket.customer.com/por/kyb.zip","document_type":"KYB_DOCUMENTS","status":"PASSED"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"id":"paths/Business checks events/post/requestBody/content/application~1json/example"},"paths/~1roles/get/responses/200/content/application~1json/examples/List Roles":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"created_at","order":"ASC"},"data":[{"id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"9c36af78-91a0-4174-a515-fc81214e3dab","entity_type":"ACCOUNT_GROUP","entity_id":"413715f2-5401-4b97-8055-034a6b879f8c","custody_type":"SOLE_CUSTODY","role_type":"GUARDIAN","status":"ACTIVE"},{"id":"e8b5a51d-8baf-4d0b-8a3b-8f8f8f8f8f8f","created_at":"2025-04-01T10:12:40Z","updated_at":"2025-04-01T10:12:40Z","user_id":"0d10c51f-33f2-4399-b8ab-92ec84e6b2f0","entity_type":"BUSINESS","entity_id":"6deb17c8-950e-4377-b500-5522af5ef712","role_type":"LEGAL_REPRESENTATIVE","status":"ACTIVE"}]},"key":"List Roles","summary":"List of roles","id":"paths/~1roles/get/responses/200/content/application~1json/examples/List Roles"},"paths/~1roles/get/responses/200/content/application~1json/examples/Empty List":{"value":{"meta":{"offset":0,"limit":100,"count":0,"total_count":0,"sort":"created_at","order":"ASC"},"data":[]},"key":"Empty List","summary":"Empty roles list","id":"paths/~1roles/get/responses/200/content/application~1json/examples/Empty List"},"paths/~1roles/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1roles/get/responses/400/content/application~1problem+json/example"},"paths/~1roles/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1roles/get/responses/401/content/application~1problem+json/example"},"paths/~1roles/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1roles/get/responses/403/content/application~1problem+json/example"},"paths/~1roles/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1roles/get/responses/406/content/application~1problem+json/example"},"paths/~1roles/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1roles/get/responses/429/content/application~1problem+json/example"},"paths/~1roles/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1roles/get/responses/500/content/application~1problem+json/example"},"paths/~1roles/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1roles/get/responses/503/content/application~1problem+json/example"},"paths/~1roles/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1roles/get/responses/504/content/application~1problem+json/example"},"paths/~1roles/post/requestBody/content/application~1json/examples/Account Group":{"value":{"user_id":"9c36af78-91a0-4174-a515-fc81214e3dab","entity_type":"ACCOUNT_GROUP","entity_id":"413715f2-5401-4b97-8055-034a6b879f8c","role_type":"GUARDIAN","custody_type":"SOLE_CUSTODY"},"key":"Account Group","summary":"Account Group role","id":"paths/~1roles/post/requestBody/content/application~1json/examples/Account Group"},"paths/~1roles/post/requestBody/content/application~1json/examples/Business":{"value":{"user_id":"0d10c51f-33f2-4399-b8ab-92ec84e6b2f0","entity_type":"BUSINESS","entity_id":"6deb17c8-950e-4377-b500-5522af5ef712","role_type":"LEGAL_REPRESENTATIVE"},"key":"Business","summary":"Business role","id":"paths/~1roles/post/requestBody/content/application~1json/examples/Business"},"paths/~1roles/post/responses/200/content/application~1json/examples/Account Group":{"value":{"id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"9c36af78-91a0-4174-a515-fc81214e3dab","entity_type":"ACCOUNT_GROUP","entity_id":"413715f2-5401-4b97-8055-034a6b879f8c","role_type":"GUARDIAN","status":"PENDING"},"key":"Account Group","summary":"Account Group role","id":"paths/~1roles/post/responses/200/content/application~1json/examples/Account Group"},"paths/~1roles/post/responses/200/content/application~1json/examples/Business":{"value":{"id":"e8b5a51d-8baf-4d0b-8a3b-8f8f8f8f8f8f","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"0d10c51f-33f2-4399-b8ab-92ec84e6b2f0","entity_type":"BUSINESS","entity_id":"6deb17c8-950e-4377-b500-5522af5ef712","role_type":"LEGAL_REPRESENTATIVE","status":"ACTIVE"},"key":"Business","summary":"Business role","id":"paths/~1roles/post/responses/200/content/application~1json/examples/Business"},"paths/~1roles/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1roles/post/responses/400/content/application~1problem+json/example"},"paths/~1roles/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1roles/post/responses/401/content/application~1problem+json/example"},"paths/~1roles/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1roles/post/responses/403/content/application~1problem+json/example"},"paths/~1roles/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1roles/post/responses/406/content/application~1problem+json/example"},"paths/~1roles/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1roles/post/responses/429/content/application~1problem+json/example"},"paths/~1roles/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1roles/post/responses/500/content/application~1problem+json/example"},"paths/~1roles/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1roles/post/responses/503/content/application~1problem+json/example"},"paths/~1roles/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1roles/post/responses/504/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group":{"value":{"id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"9c36af78-91a0-4174-a515-fc81214e3dab","entity_type":"ACCOUNT_GROUP","entity_id":"413715f2-5401-4b97-8055-034a6b879f8c","role_type":"GUARDIAN","custody_type":"JOINT_CUSTODY","status":"ACTIVE"},"key":"Account Group","summary":"Account Group role","id":"paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Account Group"},"paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business":{"value":{"id":"e8b5a51d-8baf-4d0b-8a3b-8f8f8f8f8f8f","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"0d10c51f-33f2-4399-b8ab-92ec84e6b2f0","entity_type":"BUSINESS","entity_id":"6deb17c8-950e-4377-b500-5522af5ef712","role_type":"LEGAL_REPRESENTATIVE","status":"ACTIVE"},"key":"Business","summary":"Business role","id":"paths/~1roles~1{role_id}/get/responses/200/content/application~1json/examples/Business"},"paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1roles~1{role_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1roles~1{role_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1roles~1{role_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1roles~1{role_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1roles~1{role_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1roles~1{role_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1roles~1{role_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1roles~1{role_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1roles~1{role_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1roles~1{role_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1roles~1{role_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1roles~1{role_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1roles~1{role_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1roles~1{role_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1roles~1{role_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1roles~1{role_id}/delete/responses/504/content/application~1problem+json/example"},"paths/Role events/post/requestBody/content/application~1json/examples/Account Group":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-22T09:04:42Z","type":"ROLE.CREATED","object":{"id":"baf05386-0459-4e8c-9ac9-cd6442f194dd","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"9c36af78-91a0-4174-a515-fc81214e3dab","entity_type":"ACCOUNT_GROUP","entity_id":"413715f2-5401-4b97-8055-034a6b879f8c","role_type":"GUARDIAN","custody_type":"JOINT_CUSTODY","status":"PENDING"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"Account Group","summary":"Account Group role event","id":"paths/Role events/post/requestBody/content/application~1json/examples/Account Group"},"paths/Role events/post/requestBody/content/application~1json/examples/Business":{"value":{"id":"2df83681-6a42-4837-a554-a8197335bcfa","created_at":"2021-11-22T09:04:42Z","type":"ROLE.ACTIVATED","object":{"id":"e8b5a51d-8baf-4d0b-8a3b-8f8f8f8f8f8f","created_at":"2025-04-01T10:11:40Z","updated_at":"2025-04-01T10:11:40Z","user_id":"0d10c51f-33f2-4399-b8ab-92ec84e6b2f0","entity_type":"BUSINESS","entity_id":"6deb17c8-950e-4377-b500-5522af5ef712","role_type":"LEGAL_REPRESENTATIVE","status":"ACTIVE"},"webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b"},"key":"Business","summary":"Business role event","id":"paths/Role events/post/requestBody/content/application~1json/examples/Business"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","status":"ACTIVE","tax_residencies":[{"country":"IT","tax_identifier_number":"LLLLLL99L99L999L"},{"country":"FR","missing_tin_reason":"COUNTRY_HAS_NO_TIN"},{"country":"DE","tax_identifier_number":"12345678901"}]},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/405/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1tax_residencies/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one":{"value":{"tax_residencies":[{"country":"DE","tax_identifier_number":"12345678901"}]},"key":"one","summary":"One residency","id":"paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/one"},"paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple":{"value":{"tax_residencies":[{"country":"IT","tax_identifier_number":"ABCDEF12G34H567I"},{"country":"FR","missing_tin_reason":"TIN_NOT_YET_ASSIGNED"},{"country":"DE","tax_identifier_number":"12345678901"}]},"key":"multiple","summary":"Multiple residencies","id":"paths/~1users~1{user_id}~1tax_residencies/post/requestBody/content/application~1json/examples/multiple"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","tax_residencies":[{"country":"AT","missing_tin_reason":"TIN_NOT_YET_ASSIGNED"},{"country":"DE","tax_identifier_number":"12345678901"}],"status":"ACTIVE"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1tax_residencies/post/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"}]},"id":"paths/~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1accounts/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"},"key":"User Account","summary":"User account","id":"paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/User Account"},"paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"TRADING","account_number":1,"name":"Main account","status":"ACTIVE"},"key":"Business Account","summary":"Business account","id":"paths/~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/Business Account"},"paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example":{"value":{"name":"Main account"},"id":"paths/~1accounts~1{account_id}/patch/requestBody/content/application~1json/example"},"paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"},"key":"User Account","summary":"User account","id":"paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/User Account"},"paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"TRADING","account_number":1,"name":"Main account","status":"ACTIVE"},"key":"Business Account","summary":"Business account","id":"paths/~1accounts~1{account_id}/patch/responses/200/content/application~1json/examples/Business Account"},"paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}/patch/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}/patch/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}/patch/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}/patch/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}/patch/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}/patch/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}/patch/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}/patch/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}/patch/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1accounts~1{account_id}/delete/responses/409/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1accounts/get/responses/200/content/application~1json/examples/User Account":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"}]},"key":"User Account","summary":"User account","id":"paths/~1accounts/get/responses/200/content/application~1json/examples/User Account"},"paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"TRADING","account_number":1,"name":"Main account","status":"ACTIVE"}]},"key":"Business Account","summary":"Business account","id":"paths/~1accounts/get/responses/200/content/application~1json/examples/Business Account"},"paths/~1accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts/post/requestBody/content/application~1json/examples/User Account":{"value":{"user_id":"413715f2-5401-4b97-8055-034a6b879f8c","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","name":"Main account"},"key":"User Account","summary":"User account","id":"paths/~1accounts/post/requestBody/content/application~1json/examples/User Account"},"paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account":{"value":{"business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","name":"Main account"},"key":"Business Account","summary":"Business account","id":"paths/~1accounts/post/requestBody/content/application~1json/examples/Business Account"},"paths/~1accounts/post/responses/200/content/application~1json/examples/User Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"},"key":"User Account","summary":"User account","id":"paths/~1accounts/post/responses/200/content/application~1json/examples/User Account"},"paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account":{"value":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"TRADING","account_number":1,"name":"Main account","status":"ACTIVE"},"key":"Business Account","summary":"Business account","id":"paths/~1accounts/post/responses/200/content/application~1json/examples/Business Account"},"paths/~1accounts/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts/post/responses/400/content/application~1problem+json/example"},"paths/~1accounts/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts/post/responses/401/content/application~1problem+json/example"},"paths/~1accounts/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts/post/responses/403/content/application~1problem+json/example"},"paths/~1accounts/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts/post/responses/404/content/application~1problem+json/example"},"paths/~1accounts/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts/post/responses/406/content/application~1problem+json/example"},"paths/~1accounts/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts/post/responses/429/content/application~1problem+json/example"},"paths/~1accounts/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts/post/responses/500/content/application~1problem+json/example"},"paths/~1accounts/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts/post/responses/503/content/application~1problem+json/example"},"paths/~1accounts/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts/post/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"TRADING","account_number":1,"name":"Main account","status":"ACTIVE"}]},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1accounts/get/responses/504/content/application~1problem+json/example"},"paths/Account events/post/requestBody/content/application~1json/examples/User Account":{"value":{"id":"56510309-d9de-4730-9b5b-4a0ed047f3a9","created_at":"2021-07-21T14:10:00.00Z","type":"ACCOUNT.CREATED","object":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"account_number":1,"name":"Main account","status":"ACTIVE"},"webhook_id":"b838bde5-b6df-4f1f-bfc4-71d3fb01d430"},"key":"User Account","summary":"User account event","id":"paths/Account events/post/requestBody/content/application~1json/examples/User Account"},"paths/Account events/post/requestBody/content/application~1json/examples/Business Account":{"value":{"id":"56510309-d9de-4730-9b5b-4a0ed047f3a9","created_at":"2021-07-21T14:10:00.00Z","type":"ACCOUNT.CREATED","object":{"id":"ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"fa2414ed-8d62-46fd-85ed-565a340c81d6","type":"TRADING","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","account_number":1,"name":"Main account","status":"ACTIVE"},"webhook_id":"b838bde5-b6df-4f1f-bfc4-71d3fb01d430"},"key":"Business Account","summary":"Business account event","id":"paths/Account events/post/requestBody/content/application~1json/examples/Business Account"},"paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"PERSONAL","status":"ACTIVE","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"securities_account_number":"123456789"}]},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1account_groups/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group":{"value":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"PERSONAL","status":"ACTIVE","users":[{"id":"413715f2-5401-4b97-8055-034a6b879f8c","type":"OWNER"}],"securities_account_number":"123456789"},"key":"User Account Group","summary":"User account group","id":"paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/User Account Group"},"paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group":{"value":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"BUSINESS","status":"ACTIVE","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","securities_account_number":"123456789"},"key":"Business Account Group","summary":"Business account group","id":"paths/~1account_groups~1{account_group_id}/get/responses/200/content/application~1json/examples/Business Account Group"},"paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/409/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"PERSONAL","status":"ACTIVE","users":[{"id":"9c36af78-91a0-4174-a515-fc81214e3dab","type":"OWNER"}],"securities_account_number":"123456789"}]},"key":"User Account Group","summary":"User account group","id":"paths/~1account_groups/get/responses/200/content/application~1json/examples/User Account Group"},"paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"BUSINESS","status":"ACTIVE","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","securities_account_number":"123456789"}]},"key":"Business Account Group","summary":"Business account group","id":"paths/~1account_groups/get/responses/200/content/application~1json/examples/Business Account Group"},"paths/~1account_groups/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group":{"value":{"user_id":"413715f2-5401-4b97-8055-034a6b879f8c","type":"PERSONAL","securities_account_number":"12345689"},"key":"User Account Group","summary":"User account group","id":"paths/~1account_groups/post/requestBody/content/application~1json/examples/User Account Group"},"paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group":{"value":{"business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","type":"BUSINESS","securities_account_number":"12345689"},"key":"Business Account Group","summary":"Business account group","id":"paths/~1account_groups/post/requestBody/content/application~1json/examples/Business Account Group"},"paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group":{"value":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"PERSONAL","status":"ACTIVE","users":[{"id":"413715f2-5401-4b97-8055-034a6b879f8c","type":"OWNER"}],"securities_account_number":"123456789"},"key":"User Account Group","summary":"User account group","id":"paths/~1account_groups/post/responses/200/content/application~1json/examples/User Account Group"},"paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group":{"value":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"BUSINESS","status":"ACTIVE","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","securities_account_number":"123456789"},"key":"Business Account Group","summary":"Business account group","id":"paths/~1account_groups/post/responses/200/content/application~1json/examples/Business Account Group"},"paths/~1account_groups/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups/post/responses/400/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups/post/responses/401/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups/post/responses/403/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups/post/responses/404/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups/post/responses/406/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups/post/responses/429/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups/post/responses/500/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups/post/responses/503/content/application~1problem+json/example"},"paths/~1account_groups/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups/post/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"BUSINESS","status":"ACTIVE","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","securities_account_number":"123456789"}]},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1account_groups/get/responses/504/content/application~1problem+json/example"},"paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group":{"value":{"id":"72da9e41-9926-419f-976e-4c8069a04249","created_at":"2021-07-21T14:10:00.00Z","type":"ACCOUNT_GROUP.CREATED","object":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"PERSONAL","status":"ACTIVE","users":[{"id":"413715f2-5401-4b97-8055-034a6b879f8c","type":"OWNER"}],"securities_account_number":"123456789"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"User Account Group","summary":"User account group event","id":"paths/Account Group events/post/requestBody/content/application~1json/examples/User Account Group"},"paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group":{"value":{"id":"72da9e41-9926-419f-976e-4c8069a04249","created_at":"2021-07-21T14:10:00.00Z","type":"ACCOUNT_GROUP.CREATED","object":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","type":"BUSINESS","status":"ACTIVE","business_id":"bc6f8c82-1234-4b56-a7d8-9e012345f678","securities_account_number":"123456789"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"Business Account Group","summary":"Business account group event","id":"paths/Account Group events/post/requestBody/content/application~1json/examples/Business Account Group"},"paths/Corporate Action Events/post/requestBody/content/application~1json/example":{"value":{"id":"d0cb44d6-d61f-4272-b0f5-a8c7349b8b9a","created_at":"2024-09-05T12:03:43.201937702Z","type":"CORPORATE_ACTION.UPDATED","object":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","corporate_action_reference":"DEDVCA0000000000","instrument":{"uuid":"48b798b7-3a62-4f30-8307-ee94d35b21b7","isin":"FR0010524777","name":"Lyxor MSCI New Energy ESG Filtered (DR) ETF"},"name":"CASH_DIVIDEND","iso_type":"DVCA","currency_denomination":"EUR","mandatory_voluntary_indicator":"MANDATORY","announcement_status":"PRELIMINARY_ANNOUNCEMENT_CONFIRMED","function_of_message":"NEW","announcement_date":"2023-11-09","ex_date":"2023-12-04","record_date":"2023-12-05","effective_date":"2023-12-10","options":[{"option_number":"001","option_type":"CASH","option_details":{"default_option":"TRUE"},"movements":[{"movement_type":"CASH","movement_details":{"credit_debit_indicator":"CREDIT","payment_date":"2023-12-10","gross_dividend":"0.54","withholding_tax":"0.30","currency":"EUR"}}]}]},"webhook_id":"dbebe0ac-a407-4d43-a404-b8fe846eb691"},"id":"paths/Corporate Action Events/post/requestBody/content/application~1json/example"},"paths/~1isa~1wrappers/post/requestBody/content/application~1json/example":{"value":{"account_group_id":"0d68fea2-66e8-4ea8-b507-276e7a1eb4aa","type":"STOCKS_AND_SHARES_ISA","is_flexible":true},"id":"paths/~1isa~1wrappers/post/requestBody/content/application~1json/example"},"paths/~1isa~1wrappers/post/responses/200/content/application~1json/example":{"value":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2025-10-05T14:48:00.000Z","updated_at":"2025-10-05T14:48:00.000Z","account_group_id":"0d68fea2-66e8-4ea8-b507-276e7a1eb4aa","is_flexible":true,"status":"NEW","type":"STOCKS_AND_SHARES_ISA"},"id":"paths/~1isa~1wrappers/post/responses/200/content/application~1json/example"},"paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1isa~1wrappers/post/responses/400/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1isa~1wrappers/post/responses/401/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1isa~1wrappers/post/responses/403/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1isa~1wrappers/post/responses/404/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1isa~1wrappers/post/responses/406/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1isa~1wrappers/post/responses/429/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1isa~1wrappers/post/responses/500/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1isa~1wrappers/post/responses/503/content/application~1problem+json/example"},"paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1isa~1wrappers/post/responses/504/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"valid_from","order":"DESC"},"data":[{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2025-10-05T14:48:00.000Z","updated_at":"2025-10-05T14:48:00.000Z","tax_wrapper_id":"0d68fea2-66e8-4ea8-b507-276e7a1eb4aa","tax_year":"2025/2026","type":"ANNUAL","status":"ACTIVE","currency":"GBP","used_amount":"0.00","remaining_amount":"20000.00","valid_from":"2025-04-06T00:00:00.000Z","valid_to":"2026-04-05T23:59:59.000Z","first_subscription_at":"2025-04-06T00:00:00.000Z"}]},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/200/content/application~1json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/400/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/401/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/403/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/404/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/405/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/406/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/429/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/500/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/503/content/application~1problem+json/example"},"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1isa~1wrappers~1{tax_wrapper_id}~1allowances/get/responses/504/content/application~1problem+json/example"},"paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new":{"value":{"id":"295cf14f-368c-450e-b57e-48d115d30fe4","created_at":"2025-08-01T10:34:43Z","type":"ISA_WRAPPER.NEW","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2025-08-01T10:33:43Z","updated_at":"2025-08-01T10:33:43Z","account_group_id":"d4b5c6e7-89f0-4a1b-9c2d-3e4f5a6b7c8d","is_flexible":true,"status":"NEW","type":"STOCKS_AND_SHARES_ISA"},"webhook_id":"4a80c45f-204c-4498-ac20-d900a846e166"},"key":"tax_wrapper_new","summary":"Tax Wrapper New","id":"paths/ISA tax wrapper events/post/requestBody/content/application~1json/examples/tax_wrapper_new"},"paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated":{"value":{"id":"295cf14f-368c-450e-b57e-48d115d30fe4","created_at":"2025-08-01T10:34:43Z","type":"ISA_WRAPPER_ALLOWANCE.UPDATED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2025-10-05T14:48:00.000Z","updated_at":"2025-10-05T14:48:00.000Z","tax_wrapper_id":"0d68fea2-66e8-4ea8-b507-276e7a1eb4aa","tax_year":"2025/2026","type":"ANNUAL","status":"ACTIVE","currency":"GBP","used_amount":"1000.00","remaining_amount":"19000.00","valid_from":"2025-04-06T00:00:00.000Z","valid_to":"2026-04-05T23:59:59.000Z","first_subscription_at":"2025-05-13T00:00:00.000Z"},"webhook_id":"4a80c45f-204c-4498-ac20-d900a846e166"},"key":"allowance_updated","summary":"Allowance Updated","id":"paths/ISA allowance events/post/requestBody/content/application~1json/examples/allowance_updated"},"paths/~1isa~1transfers/post/requestBody/content/application~1json/example":{"value":{"transfer_type":"ISA_EXTERNAL","user_id":"2dedfeb0-58cd-55f2-ae08-0e41fe0413d9","account_group_id":"48043cd0-e306-4b48-bbdd-6ca5d0967009","direction":"INCOMING","reference":"4XD8Z53CST3LGEZBYO","counterparty":{"account_number":"5WJSZB3C8"},"transfer_value":"10000.00","currency":"GBP","transfer_method":"CASH","transfer_date":"2025-10-10T10:00:00Z","details":{"current_year_subscription":{"transfer_amount":"2000.00","first_subscription_at":"2025-09-09T12:50:00Z"}}},"id":"paths/~1isa~1transfers/post/requestBody/content/application~1json/example"},"paths/~1isa~1transfers/post/responses/200/content/application~1json/example":{"value":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"ISA_INTERNAL","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_group_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","reference":"b82dc5985558fdr2","transfer_value":"10000.00","currency":"GBP","transfer_method":"CASH","counterparty":{"account_number":"1234567891"},"details":{"current_year_subscription":{"transfer_amount":"2000.00","first_subscription_at":"2024-01-15T10:00:00.00Z"}},"transfer_date":"2024-01-22T14:10:00.00Z"},"id":"paths/~1isa~1transfers/post/responses/200/content/application~1json/example"},"paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1isa~1transfers/post/responses/400/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1isa~1transfers/post/responses/401/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1isa~1transfers/post/responses/403/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1isa~1transfers/post/responses/404/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1isa~1transfers/post/responses/406/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1isa~1transfers/post/responses/429/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1isa~1transfers/post/responses/500/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1isa~1transfers/post/responses/503/content/application~1problem+json/example"},"paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1isa~1transfers/post/responses/504/content/application~1problem+json/example"},"paths/ISA Transfers events/post/requestBody/content/application~1json/example":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ISA_TRANSFER.NEW","object":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"ISA_INTERNAL","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_group_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","reference":"b82dc5985558fdr2","transfer_value":"10000.00","currency":"GBP","transfer_method":"CASH","counterparty":{"account_number":"1234567891"},"details":{"current_year_subscription":{"transfer_amount":"2000.00","first_subscription_at":"2024-01-15T10:00:00.00Z"}},"transfer_date":"2024-01-22T14:10:00.00Z"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"id":"paths/ISA Transfers events/post/requestBody/content/application~1json/example"},"paths/~1tax_exemptions/post/requestBody/content/application~1json/example":{"value":{"user_ids":["70fd317b-81e1-4f21-9f7e-3b5cb4dfe686"],"tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"currency":"EUR","amount":"1000"}},"country":"DE","valid_to_date":"2024-12-31"},"id":"paths/~1tax_exemptions/post/requestBody/content/application~1json/example"},"paths/~1tax_exemptions/post/responses/202/content/application~1json/example":{"value":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1"},"id":"paths/~1tax_exemptions/post/responses/202/content/application~1json/example"},"paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1tax_exemptions/post/responses/400/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1tax_exemptions/post/responses/401/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1tax_exemptions/post/responses/403/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1tax_exemptions/post/responses/404/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1tax_exemptions/post/responses/406/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1tax_exemptions/post/responses/429/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1tax_exemptions/post/responses/500/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1tax_exemptions/post/responses/503/content/application~1problem+json/example"},"paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1tax_exemptions/post/responses/504/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example":{"value":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","status":"ACTIVE","user_ids":["70821d79-366f-4873-804b-14857d690496"],"country":"DE","valid_from_date":"2024-01-01","valid_to_date":"2024-12-31","tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"amount":"1000.00","currency":"EUR"},"utilized_amount":{"amount":"0.00","currency":"EUR"},"remaining_amount":{"amount":"1000.00","currency":"EUR"}}},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/200/content/application~1json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example":{"value":{"user_ids":["70fd317b-81e1-4f21-9f7e-3b5cb4dfe686"],"tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"currency":"EUR","amount":"955"}},"country":"DE","valid_to_date":"2024-12-31"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/requestBody/content/application~1json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example":{"value":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/202/content/application~1json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/400/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/401/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/403/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/404/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/406/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/429/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/500/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/503/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/put/responses/504/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1tax_exemptions~1{tax_exemption_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","status":"ACTIVE","user_ids":["70821d79-366f-4873-804b-14857d690496"],"country":"DE","valid_from_date":"2024-01-01","valid_to_date":"2024-12-31","tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"amount":"1000.00","currency":"EUR"},"utilized_amount":{"amount":"0.00","currency":"EUR"},"remaining_amount":{"amount":"1000.00","currency":"EUR"}}}]},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/405/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1tax_exemptions/get/responses/504/content/application~1problem+json/example"},"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created":{"value":{"id":"295cf14f-368c-450e-b57e-48d115d30fe4","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.CREATED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","status":"ACTIVE","user_ids":["70821d79-366f-4873-804b-14857d690496"],"country":"DE","valid_from_date":"2024-01-01","valid_to_date":"2024-12-31","tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"amount":"1000.00","currency":"EUR"},"utilized_amount":{"amount":"0.00","currency":"EUR"},"remaining_amount":{"amount":"1000.00","currency":"EUR"}}},"webhook_id":"4a80c45f-204c-4498-ac20-d900a846e166"},"key":"tax_exemption_created","summary":"Tax Exemption Created","id":"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_created"},"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated":{"value":{"id":"295cf14f-368c-450e-b57e-48d115d30fe4","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.UPDATED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","status":"ACTIVE","user_ids":["70821d79-366f-4873-804b-14857d690496"],"country":"DE","valid_from_date":"2024-01-01","valid_to_date":"2024-12-31","tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"amount":"1000.00","currency":"EUR"},"utilized_amount":{"amount":"0.00","currency":"EUR"},"remaining_amount":{"amount":"1000.00","currency":"EUR"}}},"webhook_id":"c10c4156-5f34-46cd-82b8-4ef84f0f3e24"},"key":"tax_exemption_updated","summary":"Tax Exemption Updated","id":"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_updated"},"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted":{"value":{"id":"295cf14f-368c-450e-b57e-48d115d30fe4","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.DELETED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-09-01T01:13:03Z","status":"ACTIVE","user_ids":["70821d79-366f-4873-804b-14857d690496"],"country":"DE","valid_from_date":"2024-01-01","valid_to_date":"2024-12-31","tax_exemption_details":{"tax_exemption_type":"SINGLE","tax_exemption_amount":{"amount":"1000.00","currency":"EUR"},"utilized_amount":{"amount":"0.00","currency":"EUR"},"remaining_amount":{"amount":"1000.00","currency":"EUR"}}},"webhook_id":"cd26a6ce-7a1c-47de-a6fc-b5dfd996da99"},"key":"tax_exemption_deleted","summary":"Tax Exemption Deleted","id":"paths/Tax exemption events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"},"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created":{"value":{"id":"2ce641a1-e89c-43be-b8d8-981d4aac5bd5","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.CREATION_FAILED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","reason":"Missing TIN","status":"CANCELLED","user_ids":["70821d79-366f-4873-804b-14857d690496"]},"webhook_id":"606e3c01-c9cf-4073-900e-718bfc521953"},"key":"tax_exemption_created","summary":"Tax Exemption Created","id":"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_created"},"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated":{"value":{"id":"2ce641a1-e89c-43be-b8d8-981d4aac5bd5","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.UPDATE_FAILED","object":{"id":"f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1","created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z","reason":"Invalid Amount","status":"CANCELLED","user_ids":["70821d79-366f-4873-804b-14857d690496"]},"webhook_id":"0a50586f-74d7-49ea-b2e8-bb02e9e8ee3b"},"key":"tax_exemption_updated","summary":"Tax Exemption Updated","id":"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_updated"},"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted":{"value":{"id":"43020799-f975-4973-aa5a-be2536efb6dd","created_at":"2024-01-01T10:34:43Z","type":"TAX_EXEMPTION.DELETION_FAILED","object":{"id":"f1670eb3-ccfc-473b-b628-0d8530ebe62d","reason":"Tax exemption amount already utilised","status":"ACTIVE","user_ids":["a9947111-579b-4652-a53d-d7b81f2e50c8"],"created_at":"2024-01-01T10:33:43Z","updated_at":"2024-01-01T10:33:43Z"},"webhook_id":"c2588a12-a22b-4d79-bada-24cfb9794727"},"key":"tax_exemption_deleted","summary":"Tax Exemption Deleted","id":"paths/Tax exemption failure events/post/requestBody/content/application~1json/examples/tax_exemption_deleted"},"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2024-08-19T13:06:57.820371265Z","type":"TAX_COLLECTION.CREATED","webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","object":{"account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","collection_amount":{"amount":"100.00","currency":"EUR"},"id":"d77e6924-9bb7-4db0-addc-404442258f4b","type":"TAX_PREPAYMENT_DE","instrument":{"uuid":"d77e6924-9bb7-4db0-addc-404442258f4b","isin":"DE000A0D8QZ0"},"processed_amount":{"cash_balance":{"amount":"0.00","currency":"EUR"},"sell_to_cover":{"amount":"0.00","currency":"EUR"},"offset_amount":{"amount":"0.00","currency":"EUR"}},"status":"PROCESSING","updated_at":"2024-08-19T13:06:57.820371265Z","created_at":"2024-08-19T13:06:57.820371265Z"}},"key":"tax_collection_created","summary":"Tax Collection Created","id":"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_created"},"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2024-08-19T13:06:59.000000000Z","type":"TAX_COLLECTION.FINALISED","webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","object":{"account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","collection_amount":{"amount":"100.00","currency":"EUR"},"id":"d77e6924-9bb7-4db0-addc-404442258f4b","type":"TAX_PREPAYMENT_DE","instrument":{"uuid":"d77e6924-9bb7-4db0-addc-404442258f4b","isin":"DE000A0D8QZ0"},"processed_amount":{"cash_balance":{"amount":"0.00","currency":"EUR"},"sell_to_cover":{"amount":"90.00","currency":"EUR"},"offset_amount":{"amount":"10.00","currency":"EUR"}},"status":"FINALISED","updated_at":"2024-08-19T13:06:59.000000000Z","created_at":"2024-08-19T13:06:57.820371265Z","references":[{"id":"CA_AUTO_50087_265145_I_0","type":"EXTERNAL_TAX_TRANSACTION_ID"}]}},"key":"tax_collection_finalised","summary":"Tax Collection Finalised","id":"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_finalised"},"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2024-08-19T13:06:59.000000000Z","type":"TAX_COLLECTION.CANCELLED","webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","object":{"account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","collection_amount":{"amount":"100.00","currency":"EUR"},"id":"d77e6924-9bb7-4db0-addc-404442258f4b","type":"TAX_PREPAYMENT_DE","instrument":{"uuid":"d77e6924-9bb7-4db0-addc-404442258f4b","isin":"DE000A0D8QZ0"},"processed_amount":{"cash_balance":{"amount":"0.00","currency":"EUR"},"sell_to_cover":{"amount":"0.00","currency":"EUR"},"offset_amount":{"amount":"0.00","currency":"EUR"}},"status":"CANCELLED","updated_at":"2024-08-19T13:06:59.000000000Z","created_at":"2024-08-19T13:06:57.820371265Z"}},"key":"tax_collection_cancelled","summary":"Tax Collection Cancelled","id":"paths/Tax collection events/post/requestBody/content/application~1json/examples/tax_collection_cancelled"},"paths/~1instruments/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":10,"sort":"created_at","order":"ASC"},"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2022-08-31T17:28:00.00Z","updated_at":"2022-08-31T17:28:00.00Z","isin":"DE0007664005","wkn":"766400","name":"Volkswagen (VW) St. Aktie.","fractional_trading":true,"trading_status":"ACTIVE"}]},"id":"paths/~1instruments/get/responses/200/content/application~1json/example"},"paths/~1instruments/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1instruments/get/responses/400/content/application~1problem+json/example"},"paths/~1instruments/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1instruments/get/responses/401/content/application~1problem+json/example"},"paths/~1instruments/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1instruments/get/responses/403/content/application~1problem+json/example"},"paths/~1instruments/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1instruments/get/responses/406/content/application~1problem+json/example"},"paths/~1instruments/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1instruments/get/responses/429/content/application~1problem+json/example"},"paths/~1instruments/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1instruments/get/responses/500/content/application~1problem+json/example"},"paths/~1instruments/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1instruments/get/responses/503/content/application~1problem+json/example"},"paths/~1instruments/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1instruments/get/responses/504/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2022-08-31T17:28:00.00Z","updated_at":"2022-08-31T17:28:00.00Z","isin":"DE0007664005","wkn":"766400","name":"Volkswagen (VW) St. Aktie.","fractional_trading":true,"trading_status":"ACTIVE"},"id":"paths/~1instruments~1{instrument_id}/get/responses/200/content/application~1json/example"},"paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1instruments~1{instrument_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1instruments~1{instrument_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1instruments~1{instrument_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1instruments~1{instrument_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1instruments~1{instrument_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1instruments~1{instrument_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1instruments~1{instrument_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1instruments~1{instrument_id}/get/responses/504/content/application~1problem+json/example"},"paths/Instruments events/post/requestBody/content/application~1json/example":{"value":{"id":"de4e9e75-5c74-44c7-b741-9b3e0d85f4de","created_at":"2022-08-31T17:28:00.00Z","type":"INSTRUMENT.ACTIVATED","object":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2022-03-31T17:28:00.00Z","updated_at":"2022-08-31T17:28:00.00Z","isin":"DE0007664005","wkn":"766400","name":"Volkswagen (VW) St. Aktie.","fractional_trading":true,"trading_status":"ACTIVE"},"webhook_id":"0af63506-289c-4051-8859-4e17ec89b002"},"id":"paths/Instruments events/post/requestBody/content/application~1json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"20d6024b-2df4-41ae-8d42-62e4744e455b","name":"Tradegate","price_qualities":["EOD","REALTIME"]}]},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/200/content/application~1json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/401/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/403/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/404/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/406/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/429/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/500/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/503/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1instruments~1{instrument_id}~1venues/get/responses/504/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example":{"value":{"price_quality":"REALTIME","currency":"EUR","bids":[{"time":"2023-01-09T13:02:15Z","price":"210.01","size":"100"}],"asks":[{"time":"2023-01-09T13:02:15Z","price":"212.32","size":"50"}],"last_trade":{"time":"2023-01-09T12:59:04Z","price":"211.32","size":"40"}},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/200/content/application~1json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/400/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/401/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/403/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/404/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/406/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/429/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/500/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/503/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1latest/get/responses/504/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example":{"value":{"data":[{"currency":"EUR","time":"2023-01-09","open":"213.32","high":"215.32","low":"210.32","close":"213.22","volume":"277973"},{"currency":"EUR","time":"2023-01-10","open":"214.42","high":"214.42","low":"213.22","close":"213.22","volume":"260335"}],"meta":{"count":2}},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/200/content/application~1json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/400/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/401/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/403/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/404/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/406/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/429/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/500/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/503/content/application~1problem+json/example"},"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1instruments~1{instrument_id}~1venues~1{venue_id}~1prices~1ohlc/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"56.65","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0.05","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"FILLED","fee":"0.5","executions":[{"id":"b9dc0676-8a7d-412d-802a-3b325eefd15e","side":"BUY","currency":"EUR","status":"FILLED","order_id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","cash_amount":"56.65","share_quantity":"0.05","price":"130.65","transaction_time":"2021-07-21T14:10:00.00Z","taxes":[{"amount":"1.3","type":"TOTAL"}],"venue_id":"20d6024b-2df4-41ae-8d42-62e4744e455b"}],"client_reference":"","initiation_flow":"API"}]},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1orders/get/responses/504/content/application~1problem+json/example"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":""},"key":"place_nominal_buy","summary":"Nominal Buy Order Request","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","fee_configuration":[{"cash_amount":"0.90","currency":"EUR","type":"TRANSACTION_FEE_BUY","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE"}]},"key":"place_nominal_buy_with_fee_configuration","summary":"Nominal Buy Order Request with fee configuration","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_configuration"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"}]},"key":"place_nominal_buy_with_fee_model","summary":"Nominal Buy Order Request with fee model","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_nominal_buy_with_fee_model"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":""},"key":"place_unit_sell","summary":"Unit Sell Order Request","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","fee_configuration":[{"cash_amount":"0.90","currency":"EUR","type":"TRANSACTION_FEE_SELL","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE"}]},"key":"place_unit_sell_with_fee_configuration","summary":"Unit Sell Order Request with fee configuration","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_configuration"},"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model":{"value":{"user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","fee_configuration":[{"type":"TRANSACTION_FEE_SELL","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"}]},"key":"place_unit_sell_with_fee_model","summary":"Unit Sell Order Request with fee configuration","id":"paths/~1orders/post/requestBody/content/application~1json/examples/place_unit_sell_with_fee_model"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API"},"key":"place_nominal_buy","summary":"Nominal Buy Order Response","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API","fee_configuration":[{"cash_amount":"0.90","currency":"EUR","type":"TRANSACTION_FEE_BUY","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE"}]},"key":"place_nominal_buy_with_fee_configuration","summary":"Nominal Buy Order Response with fee configuration","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_configuration"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"}]},"key":"place_nominal_buy_with_fee_model","summary":"Nominal Buy Order Response with fee model","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_with_fee_model"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"FILLED","fee":"0.0","executions":[{"id":"b9dc0676-8a7d-412d-802a-3b325eefd15e","side":"BUY","currency":"EUR","status":"FILLED","order_id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","cash_amount":"1000","share_quantity":"11.734334663","price":"85.22","transaction_time":"2021-07-21T14:10:00.020Z","taxes":[{"type":"TOTAL","amount":"0"}],"venue_id":"20d6024b-2df4-41ae-8d42-62e4744e455b"}],"client_reference":"","initiation_flow":"API"},"key":"place_nominal_buy_executions","summary":"Nominal Buy Order Response with Executions","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_nominal_buy_executions"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"0","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API"},"key":"place_unit_sell","summary":"Unit Sell Order Response","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"0","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API","fee_configuration":[{"cash_amount":"0.90","charge_method":"CHARGED_BY_CLIENT","currency":"EUR","type":"TRANSACTION_FEE_SELL","value_type":"ABSOLUTE"}]},"key":"place_unit_sell_with_fee_configuration","summary":"Unit Sell Order Response with fee configuration","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_configuration"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"0","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.0","executions":[],"client_reference":"","initiation_flow":"API","fee_configuration":[{"type":"TRANSACTION_FEE_SELL","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"}]},"key":"place_unit_sell_with_fee_model","summary":"Unit Sell Order Response with fee model","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_with_fee_model"},"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"0","currency":"EUR","side":"SELL","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"10","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"FILLED","fee":"0.0","executions":[{"id":"b9dc0676-8a7d-412d-802a-3b325eefd15e","side":"SELL","currency":"EUR","status":"FILLED","order_id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","cash_amount":"852.20","share_quantity":"10","price":"85.22","transaction_time":"2021-07-21T14:10:00.020Z","taxes":[{"type":"TOTAL","amount":"23.45"}],"venue_id":"20d6024b-2df4-41ae-8d42-62e4744e455b"}],"client_reference":"","initiation_flow":"API"},"key":"place_unit_sell_executions","summary":"Unit Sell Order Response with Executions","id":"paths/~1orders/post/responses/202/content/application~1json/examples/place_unit_sell_executions"},"paths/~1orders/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1orders/post/responses/400/content/application~1problem+json/example"},"paths/~1orders/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1orders/post/responses/401/content/application~1problem+json/example"},"paths/~1orders/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1orders/post/responses/403/content/application~1problem+json/example"},"paths/~1orders/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1orders/post/responses/406/content/application~1problem+json/example"},"paths/~1orders/post/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1orders/post/responses/422/content/application~1problem+json/example"},"paths/~1orders/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1orders/post/responses/429/content/application~1problem+json/example"},"paths/~1orders/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1orders/post/responses/500/content/application~1problem+json/example"},"paths/~1orders/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1orders/post/responses/503/content/application~1problem+json/example"},"paths/~1orders/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1orders/post/responses/504/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"56.65","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0.05","user_instrument_fit_acknowledgement":true,"limit_price":"","stop_price":"","status":"NEW","fee":"0.5","executions":[],"client_reference":"","initiation_flow":"API","execution_flow":"STRAIGHT_THROUGH"},"id":"paths/~1orders~1{order_id}/get/responses/200/content/application~1json/example"},"paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1orders~1{order_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1orders~1{order_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1orders~1{order_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1orders~1{order_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1orders~1{order_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1orders~1{order_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1orders~1{order_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1orders~1{order_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c"},"id":"paths/~1orders~1{order_id}/delete/responses/202/content/application~1json/example"},"paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1orders~1{order_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1orders~1{order_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1orders~1{order_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1orders~1{order_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1orders~1{order_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1orders~1{order_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1orders~1{order_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1orders~1{order_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example":{"value":{"id":"b9dc0676-8a7d-412d-802a-3b325eefd15e","side":"BUY","currency":"EUR","status":"SETTLED","order_id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","cash_amount":"56.65","share_quantity":"0.05","price":"130.65","transaction_time":"2021-07-21T14:10:00.00Z","taxes":[{"amount":"1.3","type":"TOTAL"}],"settlement_date":"2021-07-23","venue_id":"20d6024b-2df4-41ae-8d42-62e4744e455b"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/200/content/application~1json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1orders~1{order_id}~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"},"paths/Orders events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"ORDER.NEW","object":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"2dedfeb0-58cd-44f2-ae08-0e41fe0413d9","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"56.65","currency":"EUR","side":"BUY","instrument_id":"US0378331005","instrument_id_type":"ISIN","order_type":"MARKET","quantity":"0.05","status":"NEW","fee":"0.5","executions":[],"initiation_flow":"API"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Orders events/post/requestBody/content/application~1json/example"},"paths/Executions events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2022-11-17T10:42:34.758Z","type":"EXECUTION.FILLED","object":{"cash_amount":"852.20","currency":"EUR","id":"b40f4631-e83b-4737-a003-c0cb36382bc5","order_id":"cd2d6019-c11d-4114-aab3-b2e5dbe58cbf","price":"85.22","share_quantity":"10","side":"BUY","status":"FILLED","taxes":[{"amount":"0","type":"TOTAL"}],"transaction_time":"2022-11-17T10:42:34.758Z","venue_id":"20d6024b-2df4-41ae-8d42-62e4744e455b"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Executions events/post/requestBody/content/application~1json/example"},"paths/Order Cancellations events/post/requestBody/content/application~1json/example":{"value":{"id":"e0b1f0ac-d34a-4f07-b268-545278110231","created_at":"2023-08-01T14:10:00.00Z","type":"ORDER_CANCELLATION.REJECTED","object":{"order_id":"120c5382-d400-4a8e-95fc-d297903f3568","status":"REJECTED","reason":"Cancellation not possible"},"webhook_id":"0e225118-168c-4d4d-84d9-c36096163162"},"id":"paths/Order Cancellations events/post/requestBody/content/application~1json/example"},"paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"c27c1fdc-b129-4d7a-95ac-c8a4f05d2804","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.7"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.3"}]}]},"id":"paths/~1portfolios~1allocations/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1allocations/get/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1allocations/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1allocations/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1allocations/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1allocations/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1allocations/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1allocations/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1allocations/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example":{"value":{"name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.7"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.3"}]},"id":"paths/~1portfolios~1allocations/post/requestBody/content/application~1json/example"},"paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example":{"value":{"id":"436244bb-4afd-4002-b53b-b1d7a3bca032","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.7"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.3"}]},"id":"paths/~1portfolios~1allocations/post/responses/200/content/application~1json/example"},"paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1allocations/post/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1allocations/post/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1allocations/post/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1allocations/post/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1allocations/post/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1allocations/post/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1allocations/post/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations/post/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1allocations/post/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example":{"value":{"id":"bf5f2676-4535-403d-bc66-06ec38cc70af","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.7"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.3"}]},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary":{"value":{"allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.6"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.4"}]},"key":"ordinary","summary":"Generic instruments","id":"paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/ordinary"},"paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest":{"value":{"allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.5"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.25"},{"instrument_id":"c2721bc0-9f65-474b-a846-b237eb17fb05","instrument_id_type":"UPVEST","weight":"0.25"}]},"key":"upvest","summary":"Including Upvest-specific instruments","id":"paths/~1portfolios~1allocations~1{allocation_id}/put/requestBody/content/application~1json/examples/upvest"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example":{"value":{"id":"436244bb-4afd-4002-b53b-b1d7a3bca032","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-22T15:10:00.00Z","name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.6"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.4"}]},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/200/content/application~1json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1allocations~1{allocation_id}/put/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"account_id","order":"ASC"},"data":[{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","account_id":"4ca934ae-66b2-4494-86f9-df6ab89351f1","allocation_id":"65c69f95-c7b9-4c93-9943-a8c7fe4f7aef","rebalancing_strategy_ids":["7a7322f5-b45d-4aba-aae4-c12797938c93","d7b4291b-5a26-40c2-a8dd-235bd904a2ed"]},{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","account_id":"a46c4531-ec90-4ac3-ac6b-356d743a3859","allocation_id":"a4117e26-7c31-43ad-af47-0784a4957da9","rebalancing_strategy_ids":["7a7322f5-b45d-4aba-aae4-c12797938c93","692e318a-d6d0-43ac-999a-b84a82dbe304"]}]},"id":"paths/~1portfolios~1configurations/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1configurations/get/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1configurations/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1configurations/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1configurations/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1configurations/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1configurations/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1configurations/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1configurations/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example":{"value":{"account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"eb68abce-29f4-483f-a384-7f243e77851f"},"id":"paths/~1portfolios~1configurations/post/requestBody/content/application~1json/example"},"paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"eb68abce-29f4-483f-a384-7f243e77851f","rebalancing_strategy_ids":["7a7322f5-b45d-4aba-aae4-c12797938c93","fd8e5363-a89c-4a2f-b3c6-5f857721625f"]},"id":"paths/~1portfolios~1configurations/post/responses/200/content/application~1json/example"},"paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1configurations/post/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1configurations/post/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1configurations/post/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1configurations/post/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1configurations/post/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1portfolios~1configurations/post/responses/422/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1configurations/post/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1configurations/post/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations/post/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1configurations/post/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"eb68abce-29f4-483f-a384-7f243e77851f","rebalancing_strategy_ids":["7a7322f5-b45d-4aba-aae4-c12797938c93","fd8e5363-a89c-4a2f-b3c6-5f857721625f"]},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example":{"value":{"allocation_id":"359e9c9e-b91c-4853-8674-e6657af609fc"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-22T15:10:00.00Z","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"359e9c9e-b91c-4853-8674-e6657af609fc","rebalancing_strategy_ids":["7a7322f5-b45d-4aba-aae4-c12797938c93","fd8e5363-a89c-4a2f-b3c6-5f857721625f"]},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1configurations~1{account_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","allocation_id":"eb68abce-29f4-483f-a384-7f243e77851f","cash_amount":"1000","currency":"EUR","status":"PROCESSING","type":"SELL","post_tax":false,"client_reference":"","initiation_flow":"API","orders":[{"id":"b291d8a4-21f5-4c52-8590-4f90ce54d0b1","side":"SELL","status":"NEW"},{"id":"81d02bd9-7b9d-443d-bbfa-31df4d543f7d","side":"SELL","status":"PROCESSING"},{"id":"e97fb564-ebb4-4f37-930a-bda49c09a2e4","side":"SELL","status":"FILLED"}]}]},"id":"paths/~1portfolios~1orders/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1orders/get/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1orders/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1orders/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1orders/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1orders/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1orders/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1orders/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1orders/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1orders/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1orders/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy":{"value":{"user_id":"4b9732bd-7496-4e91-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","cash_amount":"100.00","currency":"EUR","side":"BUY"},"key":"buy","summary":"Buy","id":"paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/buy"},"paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell":{"value":{"user_id":"4b9732bd-7496-4e91-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","cash_amount":"1000.00","currency":"EUR","side":"SELL"},"key":"sell","summary":"Sell","id":"paths/~1portfolios~1orders/post/requestBody/content/application~1json/examples/sell"},"paths/~1portfolios~1orders/post/responses/200/content/application~1json/example":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","allocation_id":"eb68abce-29f4-483f-a384-7f243e77851f","cash_amount":"1000","currency":"EUR","status":"NEW","type":"BUY","post_tax":false,"client_reference":"","initiation_flow":"API","orders":[]},"id":"paths/~1portfolios~1orders/post/responses/200/content/application~1json/example"},"paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1orders/post/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1orders/post/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1orders/post/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1orders/post/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1orders/post/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1orders/post/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1orders/post/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1orders/post/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1orders/post/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary":{"value":{"id":"29bc9a26-a6ee-47a3-b609-47d30a737afc","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"4b9732bd-7496-4e91-8a5f-6360479d7fed","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"19a902ac-1c01-4c45-bd5d-62fd496805c8","cash_amount":"100.00","currency":"EUR","status":"PROCESSING","type":"BUY","client_reference":"fd1ae99e-772a-11ee-b962-0242ac120002","initiation_flow":"SAVINGS_PLAN","post_tax":false,"orders":[{"id":"79f2c816-13ed-4588-85e6-f3398b0b5825","side":"BUY","status":"NEW"},{"id":"44f50a4e-7ce8-4eae-a078-f4b3d8ab4708","side":"BUY","status":"NEW"}]},"key":"ordinary","summary":"Ordinary","id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/ordinary"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","allocation_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"0","currency":"EUR","status":"PROCESSING","type":"REBALANCING","client_reference":"","initiation_flow":"API","post_tax":false,"orders":[{"id":"e7aecb80-5e84-4bf7-984b-b39ab77eb0a8","side":"SELL","status":"NEW"},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","side":"SELL","status":"PROCESSING"},{"id":"d8a85120-2941-4ed6-8d57-e80401a4779c","side":"SELL","status":"FILLED"}]},"key":"rebalancing","summary":"Rebalancing","id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/rebalancing"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled":{"value":{"id":"29bc9a26-a6ee-47a3-b609-47d30a737afc","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","user_id":"4b9732bd-7496-4e91-8a5f-6360479d7fed","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","allocation_id":"19a902ac-1c01-4c45-bd5d-62fd496805c8","cash_amount":"100.00","currency":"EUR","status":"CANCELLED","type":"BUY","client_reference":"fd1ae99e-772a-11ee-b962-0242ac120002","initiation_flow":"API","post_tax":false,"cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"Cancelled as a result of client's request.","orders":[]},"key":"cancelled","summary":"Cancelled","id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/200/content/application~1json/examples/cancelled"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1orders~1{portfolio_order_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"81d6e710-37e6-4a5a-9877-ef5bb6d717e3"}]},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1allocations~1{allocation_id}~1accounts/get/responses/504/content/application~1problem+json/example"},"paths/Portfolio orders events/post/requestBody/content/application~1json/example":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2021-07-21T14:10:00.00Z","type":"PORTFOLIO_ORDER.NEW","object":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","allocation_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","status":"PROCESSING","type":"SELL","post_tax":false,"client_reference":"","initiation_flow":"API","orders":[{"id":"e7aecb80-5e84-4bf7-984b-b39ab77eb0a8","side":"SELL","status":"NEW"},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","side":"SELL","status":"PROCESSING"},{"id":"d8a85120-2941-4ed6-8d57-e80401a4779c","side":"SELL","status":"FILLED"}]},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"id":"paths/Portfolio orders events/post/requestBody/content/application~1json/example"},"paths/Portfolio allocations events/post/requestBody/content/application~1json/example":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2021-07-21T14:10:00.00Z","type":"PORTFOLIO_ALLOCATION.CREATED","object":{"id":"436244bb-4afd-4002-b53b-b1d7a3bca032","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","name":"Allocation 1","allocation":[{"instrument_id":"IE00B0M62Q58","instrument_id_type":"ISIN","weight":"0.7"},{"instrument_id":"US0378331005","instrument_id_type":"ISIN","weight":"0.3"}]},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"id":"paths/Portfolio allocations events/post/requestBody/content/application~1json/example"},"paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts":{"value":{"accounts":["43801b85-bbcf-41c7-8389-b018082a5ec5","20151679-c159-4f16-b8a2-267b3d968c6f"]},"key":"accounts","summary":"Accounts","id":"paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/accounts"},"paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations":{"value":{"allocations":["eafa39e3-7837-476f-8af1-49fa604e3f49"]},"key":"allocations","summary":"Allocations","id":"paths/~1portfolios~1rebalancings~1executions/post/requestBody/content/application~1json/examples/allocations"},"paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example":{"value":{"id":"735381ce-8380-4b07-9e42-97e2b6d3643e"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/200/content/application~1json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1rebalancings~1executions/post/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example":{"value":{"id":"735381ce-8380-4b07-9e42-97e2b6d3643e","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","accounts":["43801b85-bbcf-41c7-8389-b018082a5ec5","20151679-c159-4f16-b8a2-267b3d968c6f"],"allocations":[]},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example":{"value":{"meta":{"count":2,"limit":10,"offset":0,"order":"ASC","sort":"state","total_count":2},"data":[{"id":"adf706aa-4fac-4e1d-878b-5b225f7b7354","created_at":"2022-09-28T09:14:02Z","updated_at":"2022-09-28T09:14:02Z","execution_id":"edc74b48-a377-4b93-84fb-543b1137de05","account_id":"100bb408-149c-4e6f-8697-837c2a144a29","portfolio_order_id":"b31723e0-8c8c-4bd0-a962-8bd26c5aee4d","status":"FILLED"},{"id":"1dd8cede-a326-43b3-a54c-9d2d0e80edb5","created_at":"2022-09-28T09:14:02Z","updated_at":"2022-09-28T09:14:02Z","execution_id":"f678fe2b-ffd8-4b99-844f-a8f78a67e528","account_id":"98b21a45-5ea0-481f-bb1e-880aab0d154d","portfolio_order_id":"411c625e-b2f4-4af4-ac21-e17846fb6bcc","status":"PROCESSING"},{"id":"1bf46252-ad90-4e22-8717-9586d2b86327","created_at":"2022-09-28T09:14:02Z","updated_at":"2022-09-28T09:14:02Z","execution_id":"9275e08d-012f-40bd-80b7-58037bdc7ab6","portfolio_order_id":null,"account_id":"98b21a45-5ea0-481f-bb1e-880aab0d154d","status":"NEW"},{"id":"1bf46252-ad90-4e22-8717-9586d2b86327","created_at":"2022-09-28T09:14:02Z","updated_at":"2022-09-28T09:14:02Z","execution_id":"9275e08d-012f-40bd-80b7-58037bdc7ab6","portfolio_order_id":null,"account_id":"98b21a45-5ea0-481f-bb1e-880aab0d154d","status":"CANCELLED","cancellation_reason":"PORTFOLIO_IS_BALANCED","cancellation_details":"Portfolio is balanced, no need to rebalance."}]},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/200/content/application~1json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/400/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/401/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/403/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/404/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/405/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/406/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/429/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/500/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/503/content/application~1problem+json/example"},"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1portfolios~1rebalancings~1executions~1{execution_id}~1orders/get/responses/504/content/application~1problem+json/example"},"paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2021-07-21T14:10:00.00Z","type":"REBALANCING_EXECUTION_ORDER.NEW","object":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","execution_id":"760abce7-e6b5-440b-bdf3-88e35ed6417a","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","portfolio_order_id":"4f2f5db9-ef4e-4dbf-80a1-bffc71985d6c","status":"PROCESSING"},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"id":"paths/Portfolio rebalancing execution orders events/post/requestBody/content/application~1json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Instrument savings plan","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}],"cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/instrument"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Portfolio savings plan","type":"PORTFOLIO","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/200/content/application~1json/examples/portfolio"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/405/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans~1{savings_plan_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/409/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans~1{savings_plan_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Instrument savings plan","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}],"cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"}]},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans/get/responses/200/content/application~1json/examples/instrument"},"paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Portfolio savings plan","type":"PORTFOLIO","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"}]},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans/get/responses/200/content/application~1json/examples/portfolio"},"paths/~1savings_plans/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1savings_plans/get/responses/400/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans/get/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans/get/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans/get/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1savings_plans/get/responses/405/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans/get/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans/get/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans/get/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans/get/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans/get/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument":{"value":{"user_id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Instrument savings plan","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":2,"fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}]},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans/post/requestBody/content/application~1json/examples/instrument"},"paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio":{"value":{"user_id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Portfolio savings plan","type":"PORTFOLIO","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans/post/requestBody/content/application~1json/examples/portfolio"},"paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Instrument savings plan","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}],"cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans/post/responses/202/content/application~1json/examples/instrument"},"paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Portfolio savings plan","type":"PORTFOLIO","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans/post/responses/202/content/application~1json/examples/portfolio"},"paths/~1savings_plans/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1savings_plans/post/responses/400/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans/post/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans/post/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans/post/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1savings_plans/post/responses/405/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans/post/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans/post/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans/post/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans/post/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans/post/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":"68068440-6b8e-4700-8cfc-95bf21b34b96","cash_amount":"100","currency":"EUR","status":"FILLED","type":"INSTRUMENT","instrument_id":"IE00BYTRRD19","instrument_id_type":"ISIN","execution_date":"2023-07-24"},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/instrument"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio":{"value":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":"68068440-6b8e-4700-8cfc-95bf21b34b96","cash_amount":"100","currency":"EUR","status":"FILLED","type":"PORTFOLIO","execution_date":"2023-07-24"},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/200/content/application~1json/examples/portfolio"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/405/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/409/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions~1{savings_plan_execution_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"execution_date","order":"ASC"},"data":[{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":"68068440-6b8e-4700-8cfc-95bf21b34b96","cash_amount":"100","currency":"EUR","status":"FILLED","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","execution_date":"2023-10-05","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}]}]},"key":"instrument","summary":"instrument","id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/instrument"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"execution_date","order":"ASC"},"data":[{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":"68068440-6b8e-4700-8cfc-95bf21b34b96","cash_amount":"100","currency":"EUR","status":"FILLED","type":"PORTFOLIO","execution_date":"2023-10-05"}]},"key":"portfolio","summary":"portfolio","id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/200/content/application~1json/examples/portfolio"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/400/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/401/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/403/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/404/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/405/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/406/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/429/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/500/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/503/content/application~1problem+json/example"},"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1savings_plans~1{savings_plan_id}~1executions/get/responses/504/content/application~1problem+json/example"},"paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2023-07-21T10:00:00.00Z","type":"SAVINGS_PLAN_EXECUTION.NEW","object":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":null,"cash_amount":"100","currency":"EUR","status":"NEW","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","execution_date":"2023-07-23","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}]},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"key":"instrument","summary":"instrument","id":"paths/Savings plan execution events/post/requestBody/content/application~1json/examples/instrument"},"paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2023-07-21T10:00:00.00Z","type":"SAVINGS_PLAN_EXECUTION.NEW","object":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","savings_plan_id":"c31083c1-1cd3-405f-95d1-f49a37f0e032","order_id":null,"cash_amount":"100","currency":"EUR","status":"NEW","type":"PORTFOLIO","execution_date":"2023-07-23"},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"key":"portfolio","summary":"portfolio","id":"paths/Savings plan execution events/post/requestBody/content/application~1json/examples/portfolio"},"paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2023-07-21T10:00:00.00Z","type":"SAVINGS_PLAN.CREATED","object":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Instrument savings plan","type":"INSTRUMENT","instrument_id":"DE0007664005","instrument_id_type":"ISIN","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","fee_configuration":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"3ae9403c-1611-46eb-84ee-e06a02bcfd08"}],"cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"key":"instrument","summary":"instrument","id":"paths/Savings plan events/post/requestBody/content/application~1json/examples/instrument"},"paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio":{"value":{"id":"54b8d84f-5bd0-4e43-bf0f-164388cb4c23","created_at":"2023-07-21T10:00:00.00Z","type":"SAVINGS_PLAN.CREATED","object":{"id":"fc34d28e-38f5-49d2-92f6-82acb79098f4","created_at":"2023-07-21T14:10:00.00Z","updated_at":"2023-07-21T15:10:00.00Z","user_id":"4b9732bd-7496-4913-8a5f-6360479d7fed","account_id":"00ef0be8-d564-43af-b3c7-11b7a2188030","name":"Portfolio savings plan","type":"PORTFOLIO","cash_amount":"100.00","currency":"EUR","start_date":"2023-07-24","period":"WEEK","interval":1,"status":"ACTIVE","cancellation_reason":"CANCELLED_BY_CLIENT","cancellation_details":"User requested cancellation"},"webhook_id":"cd2e4183-4e62-4e0f-981b-44b594d14610"},"key":"portfolio","summary":"portfolio","id":"paths/Savings plan events/post/requestBody/content/application~1json/examples/portfolio"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"c5869b0c-e107-4e68-a89a-57ad43253dd6","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","cash_amount":"1000","currency":"EUR","status":"PROCESSING","orders":[{"id":"b291d8a4-21f5-4c52-8590-4f90ce54d0b1","side":"SELL","status":"NEW"},{"id":"81d02bd9-7b9d-443d-bbfa-31df4d543f7d","side":"SELL","status":"PROCESSING"},{"id":"e97fb564-ebb4-4f37-930a-bda49c09a2e4","side":"SELL","status":"FILLED"}],"fee_collection_id":null}]},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/405/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1liquidations/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example":{"value":{"user_id":"084a00a8-4a37-4d2d-b276-71ec5e2be0e3"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example":{"value":{"id":"b2f541dc-a27b-4d5a-b970-41812b0892b9","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","user_id":"81dfb00e-9be6-4617-8994-dfd0407f34df","cash_amount":"1000","currency":"EUR","status":"NEW","orders":[],"fee_collection_id":null},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/202/content/application~1json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1liquidations/post/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example":{"value":{"id":"f386fdc4-dcd8-4dce-8acb-dae332f51483","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","user_id":"4b9732bd-7496-4e91-8a5f-6360479d7fed","account_id":"f2f7d2c7-d79b-4de2-ae9b-d01646259f9e","cash_amount":"100.00","currency":"EUR","status":"PROCESSING","orders":[{"id":"79f2c816-13ed-4588-85e6-f3398b0b5825","side":"SELL","status":"NEW"},{"id":"44f50a4e-7ce8-4eae-a078-f4b3d8ab4708","side":"SELL","status":"NEW"}],"fee_collection_id":"8a6a2b7c-3f4e-4d8a-9c1b-1234567890ab"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1liquidations~1{account_liquidation_id}/delete/responses/504/content/application~1problem+json/example"},"paths/Account liquidation events/post/requestBody/content/application~1json/example":{"value":{"id":"56510309-d9de-4730-9b5b-4a0ed047f3a9","created_at":"2021-07-21T14:10:00.00Z","type":"ACCOUNT_LIQUIDATION.NEW","object":{"id":"b2f541dc-a27b-4d5a-b970-41812b0892b9","created_at":"2021-07-21T14:10:00.000Z","updated_at":"2021-07-21T14:10:00.000Z","account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","user_id":"81dfb00e-9be6-4617-8994-dfd0407f34df","cash_amount":"1000","currency":"EUR","status":"NEW","orders":[],"fee_collection_id":null},"webhook_id":"b838bde5-b6df-4f1f-bfc4-71d3fb01d430"},"id":"paths/Account liquidation events/post/requestBody/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","user_id":"82b49999-1145-4e05-916a-567662daa7bc","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"730b8719-0bc6-401d-98dd-b2de72afbf05","cash_amount":"200.00","currency":"EUR","remittance_information":"payment for green energy portfolio","status":"NEW","purpose_code":"OTHR"}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1direct_debits/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example":{"value":{"user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"95b8304e-19fc-4cd9-8e50-82532e6b8d8c","cash_amount":"200.00","currency":"EUR","remittance_information":"payment for green energy portfolio","purpose_code":"OTHR"},"id":"paths/~1payments~1direct_debits/post/requestBody/content/application~1json/example"},"paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","user_id":"82b49999-1145-4e05-916a-567662daa7bc","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"730b8719-0bc6-401d-98dd-b2de72afbf05","cash_amount":"200.00","currency":"EUR","status":"NEW","purpose_code":"OTHR"},"id":"paths/~1payments~1direct_debits/post/responses/200/content/application~1json/example"},"paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1direct_debits/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1direct_debits/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1direct_debits/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1direct_debits/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1direct_debits/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1direct_debits/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1direct_debits/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1direct_debits/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1direct_debits/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","user_id":"82b49999-1145-4e05-916a-567662daa7bc","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"730b8719-0bc6-401d-98dd-b2de72afbf05","cash_amount":"200.00","currency":"EUR","remittance_information":"payment for green energy portfolio","status":"NEW","purpose_code":"OTHR"},"key":"ordinary","summary":"Ordinary","id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/ordinary"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","user_id":"82b49999-1145-4e05-916a-567662daa7bc","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"730b8719-0bc6-401d-98dd-b2de72afbf05","cash_amount":"200.00","currency":"EUR","remittance_information":"payment for green energy portfolio","status":"CANCELLED","cancellation_reason":"CANCELLED_BY_UPVEST","purpose_code":"OTHR"},"key":"cancelled","summary":"Cancelled","id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/200/content/application~1json/examples/cancelled"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1direct_debits~1{direct_debit_id}/get/responses/504/content/application~1problem+json/example"},"paths/Direct Debit events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"DIRECT_DEBIT.NEW","object":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","user_id":"82b49999-1145-4e05-916a-567662daa7bc","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","mandate_id":"730b8719-0bc6-401d-98dd-b2de72afbf05","cash_amount":"200.00","currency":"EUR","remittance_information":"payment for green energy portfolio","status":"NEW"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Direct Debit events/post/requestBody/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED"}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1topups/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1topups/post/requestBody/content/application~1json/example":{"value":{"account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR"},"id":"paths/~1payments~1topups/post/requestBody/content/application~1json/example"},"paths/~1payments~1topups/post/responses/200/content/application~1json/example":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED","settlement_reference":"1ab4fef9-a097-4c6f-9345-647025d5fde6"},"id":"paths/~1payments~1topups/post/responses/200/content/application~1json/example"},"paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1topups/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1topups/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1topups/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1topups/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1topups/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1topups/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1topups/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1topups/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1topups/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/200/content/application~1json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1topups~1{topup_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/422/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1topups~1{topup_id}/delete/responses/504/content/application~1problem+json/example"},"paths/Top-up events/post/requestBody/content/application~1json/example":{"value":{"id":"ac62dbc4-c94e-45e4-a16e-381c51c8de38","created_at":"2022-12-05T12:34:56Z","type":"TOPUP.SETTLED","object":{"id":"a4496ff8-ce69-4e23-9f2e-6c3c7914b95c","account_group_id":"2a761567-251b-450e-8615-025d61dcc95e","settlement_reference":"91a44df3-7278-4dee-a1bf-2bc254eca66c","cash_amount":"100.01","currency":"EUR","created_at":"2022-12-05T12:34:56Z","status":"SETTLED"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Top-up events/post/requestBody/content/application~1json/example"},"paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example":{"value":{"reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","user_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","purpose_code":"OTHR"},"id":"paths/~1payments~1withdrawals/post/requestBody/content/application~1json/example"},"paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","user_id":"b668282b-cdf3-439a-bda2-3f3c9f655bb7","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","taxes":[{"type":"TOTAL","amount":"38.00","currency":"EUR"}],"status":"NEW","purpose_code":"OTHR"},"id":"paths/~1payments~1withdrawals/post/responses/200/content/application~1json/example"},"paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1withdrawals/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1withdrawals/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1withdrawals/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1withdrawals/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1withdrawals/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1withdrawals/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1withdrawals/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1withdrawals/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1withdrawals/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","user_id":"b668282b-cdf3-439a-bda2-3f3c9f655bb7","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","taxes":[{"type":"TOTAL","amount":"38.00","currency":"EUR"}],"status":"CONFIRMED","purpose_code":"OTHR"},"key":"ordinary","summary":"Ordinary","id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/ordinary"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:16:05Z","reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","user_id":"b668282b-cdf3-439a-bda2-3f3c9f655bb7","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","taxes":[{"type":"TOTAL","amount":"38.00","currency":"EUR"}],"status":"CANCELLED","cancellation_reason":"CANCELLED_BY_BANK","purpose_code":"OTHR"},"key":"cancelled","summary":"Cancelled","id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/200/content/application~1json/examples/cancelled"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/422/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1withdrawals~1{withdrawal_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","user_id":"b668282b-cdf3-439a-bda2-3f3c9f655bb7","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","taxes":[{"type":"TOTAL","amount":"38.00","currency":"EUR"}],"status":"CONFIRMED","purpose_code":"OTHR"}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1withdrawals/get/responses/504/content/application~1problem+json/example"},"paths/Withdrawals events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"WITHDRAWAL.NEW","object":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","reference_account_id":"295378ec-036e-4f3f-ae5c-2be85c93e837","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","user_id":"b668282b-cdf3-439a-bda2-3f3c9f655bb7","amount":"200.00","currency":"EUR","remittance_information":"Withdrawal","taxes":[{"type":"TOTAL","amount":"38.00","currency":"EUR"}],"status":"NEW"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Withdrawals events/post/requestBody/content/application~1json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:23Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"CONFIRMED","cancellation_reason":null}]},"id":"paths/~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example":{"value":{"source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR"},"id":"paths/~1payments~1cash_balance_transfers/post/requestBody/content/application~1json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example":{"value":{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:22Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"ISSUED","cancellation_reason":null},"id":"paths/~1payments~1cash_balance_transfers/post/responses/200/content/application~1json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1cash_balance_transfers/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example":{"value":{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:23Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"CONFIRMED","cancellation_reason":null},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/200/content/application~1json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/422/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1cash_balance_transfers~1{cash_balance_transfer_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:23Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"CONFIRMED","cancellation_reason":null}]},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:23Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"CONFIRMED","cancellation_reason":null}]},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1payments~1cash_balance_transfers/get/responses/504/content/application~1problem+json/example"},"paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2026-06-25T14:15:23Z","type":"CASH_BALANCE_TRANSFER.CONFIRMED","object":{"id":"b3f6a0c2-1d7e-4a3b-9f21-0c2d4e6f8a10","created_at":"2026-06-25T14:15:22Z","updated_at":"2026-06-25T14:15:23Z","source_account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","target_account_group_id":"e56c14b3-8370-4c04-bc67-7092f7ec113c","amount":"200.00","currency":"EUR","status":"CONFIRMED","cancellation_reason":null},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Cash Balance Transfers events/post/requestBody/content/application~1json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"c18f80bd-401e-4836-9776-7dc24c32d35e","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","account_owner":"Max Mustermann","name":"Max's Reference Account","iban":"DE0210**********0402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"}]},"key":"SEPA","summary":"SEPA Reference Account","id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/examples/SEPA"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA":{"value":{"user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","account_owner":"Max Mustermann","name":"Max's Reference Account","iban":"DE02100500000054540402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"},"key":"SEPA","summary":"SEPA Reference Account (User)","id":"paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA"},"paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business":{"value":{"business_id":"8f8a5c5e-2a3b-4c7d-bf9e-1d2e3f4a5b6c","account_owner":"Acme GmbH","name":"Acme Business Account","iban":"DE02100500000054540402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"},"key":"SEPA_Business","summary":"SEPA Reference Account (Business)","id":"paths/~1payments~1reference_accounts/post/requestBody/content/application~1json/examples/SEPA_Business"},"paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA":{"value":{"id":"c18f80bd-401e-4836-9776-7dc24c32d35e","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","account_owner":"Max Mustermann","name":"Max's Reference Account","iban":"DE0210**********0402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"},"key":"SEPA","summary":"SEPA Reference Account (User)","id":"paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA"},"paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business":{"value":{"id":"c18f80bd-401e-4836-9776-7dc24c32d35e","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","business_id":"8f8a5c5e-2a3b-4c7d-bf9e-1d2e3f4a5b6c","account_owner":"Acme GmbH","name":"Acme Business Account","iban":"DE0210**********0402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"},"key":"SEPA_Business","summary":"SEPA Reference Account (Business)","id":"paths/~1payments~1reference_accounts/post/responses/200/content/application~1json/examples/SEPA_Business"},"paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1reference_accounts/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1reference_accounts/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1reference_accounts/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1reference_accounts/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1reference_accounts/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1reference_accounts/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1reference_accounts/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1reference_accounts/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1reference_accounts/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA":{"value":{"id":"c18f80bd-401e-4836-9776-7dc24c32d35e","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","account_owner":"Max Mustermann","name":"Max's Reference Account","iban":"DE0210**********0402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"},"key":"SEPA","summary":"SEPA Reference Account","id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/200/content/application~1json/examples/SEPA"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1reference_accounts~1{reference_account_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1},"data":[{"id":"c18f80bd-401e-4836-9776-7dc24c32d35e","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","business_id":"8f8a5c5e-2a3b-4c7d-bf9e-1d2e3f4a5b6c","account_owner":"Acme GmbH","name":"Acme Business Account","iban":"DE0210**********0402","bic":"BELADEBE","confirmed_at":"2020-08-23T14:15:22Z"}]},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1payments~1reference_accounts/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"}]},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","business_id":"b3e4f5a6-1234-4c78-9abc-def012345678","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"}]},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1payments~1mandates/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User":{"value":{"user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","iban":"DE89000000000000000000","bic":"ABCDEXXX","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"User","summary":"User account mandate","id":"paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/User"},"paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business":{"value":{"business_id":"b3e4f5a6-1234-4c78-9abc-def012345678","iban":"DE89000000000000000000","bic":"ABCDEXXX","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"Business","summary":"Business account mandate","id":"paths/~1payments~1mandates/post/requestBody/content/application~1json/examples/Business"},"paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User":{"value":{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"User","summary":"User account mandate","id":"paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/User"},"paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business":{"value":{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","business_id":"b3e4f5a6-1234-4c78-9abc-def012345678","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"Business","summary":"Business account mandate","id":"paths/~1payments~1mandates/post/responses/200/content/application~1json/examples/Business"},"paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1mandates/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1mandates/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1mandates/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1mandates/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1mandates/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1mandates/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1mandates/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1mandates/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1mandates/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User":{"value":{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","user_id":"83d83ec2-d2ca-49ff-bbea-b92b5c3be202","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"User","summary":"User account mandate","id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/User"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business":{"value":{"id":"9c5a7dea-46f2-4502-b6b5-9902a53860e4","created_at":"2020-08-24T14:15:22Z","business_id":"b3e4f5a6-1234-4c78-9abc-def012345678","iban":"DE8900**********0000","bic":"ABCDEXXX","creditor_name":"Creditor Company","creditor_id":"DE98ZZZ09999999999","creditor_address":{"address_line1":"Strasse 1","address_line2":"Company GmbH","postcode":"12345","city":"Berlin","state":"BE","country":"DE"},"type":"RECURRENT","confirmed_at":"2021-12-08T08:38:48.021Z"},"key":"Business","summary":"Business account mandate","id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/200/content/application~1json/examples/Business"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1mandates~1{mandate_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1mandates~1{mandate_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"22913092-0484-42e9-9273-9ffd6dfd0b13","created_at":"2021-07-21T14:10:00.00Z","account_group_id":"d1354aad-6da7-4da7-aaa1-e00ebfd3240d","name":"Max's Virtual Bank Account","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE89000000000000000000","bic":"ABCDEXXX"}}}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1virtual_bank_accounts/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example":{"value":{"account_group_id":"f874a64a-ceaa-42b2-b59a-39d4f62166fb","name":"Max's Virtual Bank Account"},"id":"paths/~1payments~1virtual_bank_accounts/post/requestBody/content/application~1json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example":{"value":{"id":"22913092-0484-42e9-9273-9ffd6dfd0b13","created_at":"2021-07-21T14:10:00.00Z","account_group_id":"d1354aad-6da7-4da7-aaa1-e00ebfd3240d","name":"Max's Virtual Bank Account","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE89000000000000000000","bic":"ABCDEXXX"}}},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/200/content/application~1json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/400/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/401/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/403/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/404/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/406/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/429/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/500/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/503/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1virtual_bank_accounts/post/responses/504/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example":{"value":{"id":"22913092-0484-42e9-9273-9ffd6dfd0b13","created_at":"2021-07-21T14:10:00.00Z","account_group_id":"d1354aad-6da7-4da7-aaa1-e00ebfd3240d","name":"Max's Virtual Bank Account","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE89000000000000000000","bic":"ABCDEXXX"}}},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/200/content/application~1json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1virtual_bank_accounts~1{virtual_bank_account_id}/get/responses/504/content/application~1problem+json/example"},"paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"VIRTUAL_BANK_ACCOUNT.CREATED","object":{"id":"22913092-0484-42e9-9273-9ffd6dfd0b13","created_at":"2021-07-21T14:10:00.00Z","account_group_id":"d1354aad-6da7-4da7-aaa1-e00ebfd3240d","name":"Max's Virtual Bank Account","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE89000000000000000000","bic":"ABCDEXXX"}}},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Virtual Bank Accounts events/post/requestBody/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"created_at","order":"ASC"},"data":[{"virtual_bank_account_id":"4e127ac5-dae3-487e-b76b-fef7225a8b80","name":"Max's Virtual Bank Account","currency":"EUR","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE02100500000054540402","bic":"DEUTDEFFXXX"}}},{"virtual_bank_account_id":"a38470db-f54c-4514-ad71-6904a5c2744f","name":"Max's Virtual Bank Account","currency":"EUR","owner":{"name":"Max Musterman"},"identification":{"swift":{"iban":"DE02100500000054540403","bic":"DEUTDEFFXXX"}}}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_funding_details/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED","remittance_information":"CF123456789","counterparty":{"identification":{"name":"Max Musterman"},"account":{"identification":{"iban":"DE02100500000054540402"}}},"virtual_bank_account_id":"ab8f9b19-6a31-48d3-b201-4dee92f3da0d","purpose_code":"OTHR"}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/400/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1credit_fundings/get/responses/504/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example":{"value":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED","remittance_information":"CF123456789","counterparty":{"identification":{"name":"Max Musterman"},"account":{"identification":{"iban":"DE02100500000054540402"}}},"virtual_bank_account_id":"ab8f9b19-6a31-48d3-b201-4dee92f3da0d","purpose_code":"OTHR"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/200/content/application~1json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1payments~1credit_fundings~1{credit_funding_id}/get/responses/504/content/application~1problem+json/example"},"paths/Credit Funding events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"CREDIT_FUNDING.CONFIRMED","object":{"id":"1ab4fef9-a097-4c6f-9345-647025d5fde6","created_at":"2020-08-24T14:15:22Z","account_group_id":"1ea60f56-b67b-61fc-829a-0242ac130003","cash_amount":"200.00","currency":"EUR","status":"CONFIRMED","remittance_information":"CF123456789","counterparty":{"identification":{"name":"Max Musterman"},"account":{"identification":{"iban":"DE02100500000054540402"}}},"virtual_bank_account_id":"ab8f9b19-6a31-48d3-b201-4dee92f3da0d","purpose_code":"OTHR"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Credit Funding events/post/requestBody/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example":{"value":{"meta":{"count":2,"total_count":2,"offset":0,"limit":100},"data":[{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"100","locked_for_trading":"10","pending_settlement":"10","available_for_withdrawal":"80","available_for_trading":"80"},{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"GBP","balance":"250","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"250","available_for_trading":"250"},{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"GBP","balance":"50","locked_for_trading":"10","pending_settlement":"0","available_for_withdrawal":"40","available_for_trading":"40"}]},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/200/content/application~1json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"100","locked_for_trading":"10","pending_settlement":"10","available_for_withdrawal":"80","available_for_trading":"80"},"key":"cash_balance","summary":"Cash Balance","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"1000","locked_for_trading":"1000","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"key":"nominal_buy_order_new_cash_balance_update","summary":"Cash Balance when Nominal Buy Order is still NEW","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"0","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"key":"nominal_buy_order_filled_cash_balance_update","summary":"Cash Balance after Nominal Buy Order was filled","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"828.75","locked_for_trading":"0","pending_settlement":"828.75","available_for_withdrawal":"0","available_for_trading":"828.75"},"key":"unit_sell_order_filled_cash_balance_update","summary":"Cash Balance after a Unit Sell Order was filled","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"200","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"200","available_for_trading":"0"},"key":"cash_balance_available_before_withdrawal_request","summary":"Cash Balance available before withdrawal request","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balances~1{currency}/get/responses/504/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"100","locked_for_trading":"10","pending_settlement":"10","available_for_withdrawal":"80","available_for_trading":"80"},"key":"cash_balance","summary":"Cash Balance","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"1000","locked_for_trading":"1000","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"key":"nominal_buy_order_new_cash_balance_update","summary":"Cash Balance when Nominal Buy Order is still NEW","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_new_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"0","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"key":"nominal_buy_order_filled_cash_balance_update","summary":"Cash Balance after Nominal Buy Order was filled","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"828.75","locked_for_trading":"0","pending_settlement":"828.75","available_for_withdrawal":"0","available_for_trading":"828.75"},"key":"unit_sell_order_filled_cash_balance_update","summary":"Cash Balance after a Unit Sell Order was filled","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/unit_sell_order_filled_cash_balance_update"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request":{"value":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"200","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"200","available_for_trading":"0"},"key":"cash_balance_available_before_withdrawal_request","summary":"Cash Balance available before withdrawal request","id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/200/content/application~1json/examples/cash_balance_available_before_withdrawal_request"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/401/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/403/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/404/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/406/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/429/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/500/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/503/content/application~1problem+json/example"},"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_groups~1{account_group_id}~1payments~1cash_balance/get/responses/504/content/application~1problem+json/example"},"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a724","created_at":"2021-07-21T14:10:00.00Z","type":"CASH_BALANCE.UPDATED","object":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"100","locked_for_trading":"10","pending_settlement":"10","available_for_withdrawal":"80","available_for_trading":"80"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"cash_balance_updated","summary":"Cash Balance Updated","id":"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_updated"},"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal":{"value":{"id":"a59c81ee-7770-4f6b-9ebe-8c268b78beb4","created_at":"2021-07-22T14:12:00.00Z","type":"CASH_BALANCE.UPDATED","object":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"200","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"cash_balance_not_available_for_new_withdrawal","summary":"Cash Balance not available for NEW withdrawal","id":"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_not_available_for_new_withdrawal"},"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal":{"value":{"id":"8c049f77-dc72-489d-8f5f-3871db782252","created_at":"2021-07-21T14:11:00.00Z","type":"CASH_BALANCE.UPDATED","object":{"account_group_id":"d0fc0305-97b7-4e3b-bddf-66d3c434898c","currency":"EUR","balance":"0","locked_for_trading":"0","pending_settlement":"0","available_for_withdrawal":"0","available_for_trading":"0"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"cash_balance_empty_for_confirmed_withdrawal","summary":"Cash Balance empty for CONFIRMED withdrawal","id":"paths/Cash Balance events/post/requestBody/content/application~1json/examples/cash_balance_empty_for_confirmed_withdrawal"},"paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"account_id":"c5161455-4d27-4781-bc74-f05532e49a77","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"10.4","locked_for_trading":"5","pending_settlement":"0","available_for_trading":"5.4","available_for_instruction":"5.4","settled_quantity":"10.4"}]},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1positions/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position":{"value":{"account_id":"c5161455-4d27-4781-bc74-f05532e49a77","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"10.4","locked_for_trading":"5","pending_settlement":"0","available_for_trading":"5.4","available_for_instruction":"5.4","settled_quantity":"10.4"},"key":"position","summary":"Position Example","id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/position"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update":{"value":{"account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"10","locked_for_trading":"10","pending_settlement":"0","available_for_trading":"0","available_for_instruction":"0","settled_quantity":"10"},"key":"unit_sell_order_new_and_filled_position_update","summary":"Position Example","id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_new_and_filled_position_update"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update":{"value":{"account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"0","locked_for_trading":"0","pending_settlement":"0","available_for_trading":"0","available_for_instruction":"0","settled_quantity":"0"},"key":"unit_sell_order_filled_position_update","summary":"Position Example","id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/unit_sell_order_filled_position_update"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update":{"value":{"account_id":"debf2026-f2da-4ff0-bb84-92e45babb1e3","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"11.734334663","locked_for_trading":"0","pending_settlement":"0","available_for_trading":"11.734334663","available_for_instruction":"11.734334663","settled_quantity":"11.734334663"},"key":"nominal_buy_order_filled_positions_update","summary":"Position Example","id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/200/content/application~1json/examples/nominal_buy_order_filled_positions_update"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1positions~1{instrument_id}/get/responses/504/content/application~1problem+json/example"},"paths/Positions events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a724","created_at":"2021-07-21T14:10:00.00Z","type":"POSITION.UPDATED","object":{"account_id":"c5161455-4d27-4781-bc74-f05532e49a77","instrument":{"isin":"US0378331005","uuid":"ccb86937-8a39-4160-8d33-85bf9e902321"},"quantity":"10.4","locked_for_trading":"5","pending_settlement":"2.2","available_for_trading":"5.4","available_for_instruction":"5.4","settled_quantity":"8.2"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Positions events/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example":{"value":{"id":"404b170a-9042-11ed-9a51-2eabd0c03f8a","created_at":"2023-01-10T14:15:22Z","updated_at":"2023-01-10T14:15:22Z","valuation_time":"2023-01-10T14:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"142.29","currency":"EUR"},"security_positions":[{"instrument":{"uuid":"123e4567-e89b-12d3-a456-426614174000","isin":"DE0007664005"},"value":{"amount":"104.81","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"0.65","weight":"0.736595","price_quality":"EOD"},{"instrument":{"uuid":"48b798b7-3a62-4f30-8307-ee94d35b21b7","isin":"FR0010524777"},"value":{"amount":"37.48","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"1.00","weight":"0.263405","price_quality":"EOD"},{"instrument":{"uuid":"7499ccf8-6fa5-43ef-af9e-dd062e10ab59","isin":"SE0019889775"},"quantity":"5.00","value":null,"weight":null,"price_quality":"NA"}]},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1valuations~1current/get/responses/504/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":3,"total_count":3,"sort":"created_at","order":"ASC"},"data":[{"id":"404b170a-9042-11ed-9a51-2eabd0c03f8a","created_at":"2023-01-10T14:15:22Z","updated_at":"2023-01-10T14:15:22Z","valuation_time":"2023-01-10T14:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"142.29","currency":"EUR"},"security_positions":[{"instrument":{"uuid":"123e4567-e89b-12d3-a456-426614174000","isin":"DE0007664005"},"value":{"amount":"104.81","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"0.65","weight":"0.736595"},{"instrument":{"uuid":"48b798b7-3a62-4f30-8307-ee94d35b21b7","isin":"FR0010524777"},"value":{"amount":"37.48","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"1.00","weight":"0.263405"},{"instrument":{"uuid":"7499ccf8-6fa5-43ef-af9e-dd062e10ab59","isin":"SE0019889775"},"quantity":"5.00","value":null,"weight":null}]},{"id":"adfbf024-3d31-11ef-b99b-2eabd0c03f8a","created_at":"2023-01-11T14:15:22Z","updated_at":"2023-01-11T14:15:22Z","valuation_time":"2023-01-11T14:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"104.81","currency":"EUR"},"security_positions":[{"instrument":{"uuid":"123e4567-e89b-12d3-a456-426614174000","isin":"DE0007664005"},"value":{"amount":"104.81","currency":"EUR","price_time":"2023-01-10T09:20:00Z"},"quantity":"0.65","weight":"1"}]},{"id":"be38000e-3d31-11ef-ac4e-2eabd0c03f8a","created_at":"2023-01-12T14:15:22Z","updated_at":"2023-01-12T14:15:22Z","valuation_time":"2023-01-12T14:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"0","currency":"EUR"},"security_positions":[]}]},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/405/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1valuations/get/responses/504/content/application~1problem+json/example"},"paths/Account valuation events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2023-01-10T00:15:32Z","type":"ACCOUNT_VALUATION.CREATED","object":{"id":"404b170a-9042-11ed-9a51-2eabd0c03f8a","created_at":"2023-01-10T00:15:22Z","updated_at":"2023-01-10T00:15:22Z","valuation_time":"2023-01-10T00:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"142.29","currency":"EUR"},"security_positions":[{"instrument":{"uuid":"123e4567-e89b-12d3-a456-426614174000","isin":"DE0007664005"},"value":{"amount":"104.81","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"0.65","weight":"0.736595"},{"instrument":{"uuid":"48b798b7-3a62-4f30-8307-ee94d35b21b7","isin":"FR0010524777"},"value":{"amount":"37.48","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"1.00","weight":"0.263405"}]},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Account valuation events/post/requestBody/content/application~1json/example"},"paths/Intraday account valuation events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a722","created_at":"2023-01-10T14:15:32Z","type":"INTRADAY_ACCOUNT_VALUATION.CREATED","object":{"id":"404b170a-9042-11ed-9a51-2eabd0c03f8b","created_at":"2023-01-10T14:15:22Z","updated_at":"2023-01-10T14:15:22Z","valuation_time":"2023-01-10T14:15:22Z","account_id":"51cdc0cc-9042-11ed-b017-2eabd0c03f8a","price_quality":"EOD","total_security_value":{"amount":"142.29","currency":"EUR"},"security_positions":[{"instrument":{"uuid":"123e4567-e89b-12d3-a456-426614174000","isin":"DE0007664005"},"value":{"amount":"104.81","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"0.65","weight":"0.736595"},{"instrument":{"uuid":"48b798b7-3a62-4f30-8307-ee94d35b21b7","isin":"FR0010524777"},"value":{"amount":"37.48","currency":"EUR","price_time":"2023-01-09T09:20:00Z"},"quantity":"1.00","weight":"0.263405"}]},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee7"},"id":"paths/Intraday account valuation events/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"date","order":"ASC"},"data":[{"account_id":"bbe9e784-e009-4cb6-a07c-24831897327b","date":"2023-09-01","twr":{"daily":"0.0132434142","cumulative":"0.0324353234","cumulative_start_date":"2023-08-01"}},{"account_id":"bbe9e784-e009-4cb6-a07c-24831897327b","date":"2023-09-02","twr":{"daily":"-0.005116543491","cumulative":"0.0271528232","cumulative_start_date":"2023-08-01"}}]},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/400/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/401/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/403/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/404/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/405/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/406/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/429/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/500/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/503/content/application~1problem+json/example"},"paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1accounts~1{account_id}~1returns/get/responses/504/content/application~1problem+json/example"},"paths/Account returns events/post/requestBody/content/application~1json/example":{"value":{"id":"399dc0a7-f4cb-42a4-9513-496df030381e","created_at":"2023-09-02T05:15:00Z","type":"ACCOUNT_RETURNS.CREATED","object":{"account_id":"bbe9e784-e009-4cb6-a07c-24831897327b","date":"2023-09-01","twr":{"daily":"0.0132434142","cumulative":"0.0324353234","cumulative_start_date":"2023-08-01"}},"webhook_id":"435719ac-c064-4c7a-a8b9-6db9446965de"},"id":"paths/Account returns events/post/requestBody/content/application~1json/example"},"paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example":{"value":{"account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","amount":"200.00","currency":"EUR"},"id":"paths/~1virtual_cash_balances~1increases/post/requestBody/content/application~1json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","amount":"200.00","currency":"EUR","status":"ISSUED"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/202/content/application~1json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/400/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/401/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/403/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/404/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/406/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/429/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/500/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/503/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1virtual_cash_balances~1increases/post/responses/504/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example":{"value":{"account_group_id":"2596db3b-0d03-4651-9eda-970910479dfb","amount":"200.00","currency":"EUR"},"id":"paths/~1virtual_cash_balances~1decreases/post/requestBody/content/application~1json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","amount":"200.00","currency":"EUR","status":"ISSUED"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/202/content/application~1json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/400/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/401/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/403/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/404/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/406/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/429/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/500/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/503/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1virtual_cash_balances~1decreases/post/responses/504/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/406/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example":{"value":{"status":422,"type":"unprocessable_entity"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/422/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1virtual_cash_balances~1decreases~1{virtual_cash_decrease_id}/delete/responses/504/content/application~1problem+json/example"},"paths/Virtual cash increase events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"VIRTUAL_CASH_INCREASE.ISSUED","object":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","amount":"200.00","currency":"EUR","status":"ISSUED"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Virtual cash increase events/post/requestBody/content/application~1json/example"},"paths/Virtual cash decrease events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"VIRTUAL_CASH_DECREASE.ISSUED","object":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","created_at":"2020-08-24T14:15:22Z","updated_at":"2020-08-24T14:15:22Z","account_group_id":"ac1c39e9-2101-46b8-a624-d10a9e351b6c","amount":"200.00","currency":"EUR","status":"ISSUED"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Virtual cash decrease events/post/requestBody/content/application~1json/example"},"paths/~1fees~1collections/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":3,"total_count":3,"sort":"id","order":"ASC"},"data":[{"id":"d77e6924-9bb7-4db0-addc-404442258f4b","created_at":"2022-11-30T14:16:22Z","updated_at":"2022-11-30T14:16:22Z","account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","type":"SERVICE_FEE","collection_amount":"12.41","processed_amount":{"cash_balance":"6.50","sell_to_cover":"0"},"currency":"EUR","status":"PROCESSING","period_start":"2022-11-01","period_end":"2022-11-30"},{"id":"7c5f2b11-7078-4bb9-8ed8-9dcf5eb7597f","created_at":"2022-11-30T14:16:22Z","updated_at":"2022-11-30T14:16:22Z","account_id":"5b8b1e66-cf3c-40f3-94d3-c94f2ac7abb7","account_group_id":"87805651-ad25-4a85-8c04-88a666164ad4","type":"SERVICE_FEE","collection_amount":"82.12","processed_amount":{"cash_balance":"40.00","sell_to_cover":"42.12"},"currency":"EUR","status":"FINALISED","period_start":"2022-09-01","period_end":"2022-12-31"},{"id":"85fba2a0-da2f-46ac-a2a8-b4e7c66cb375","created_at":"2022-11-30T14:16:22Z","updated_at":"2022-11-30T14:16:22Z","account_id":"c28b6611-7ac1-405a-8eb7-ab3b35caccc2","account_group_id":"f930f9d4-3e21-4ad5-a266-730821d9a9fc","type":"SERVICE_FEE_LIQUIDATION","collection_amount":"65.30","processed_amount":{"cash_balance":"0.00","sell_to_cover":"0.00"},"currency":"EUR","status":"CANCELLED","period_start":"2022-03-01","period_end":"2022-07-30"}]},"id":"paths/~1fees~1collections/get/responses/200/content/application~1json/example"},"paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1fees~1collections/get/responses/400/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1collections/get/responses/401/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1collections/get/responses/403/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1collections/get/responses/406/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1collections/get/responses/429/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1collections/get/responses/500/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1collections/get/responses/503/content/application~1problem+json/example"},"paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1collections/get/responses/504/content/application~1problem+json/example"},"paths/~1fees~1collections/post/requestBody/content/application~1json/example":{"value":{"account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","type":"SERVICE_FEE","collection_amount":"12.41","currency":"EUR","period_start":"2022-11-01","period_end":"2022-11-30"},"id":"paths/~1fees~1collections/post/requestBody/content/application~1json/example"},"paths/~1fees~1collections/post/responses/200/content/application~1json/example":{"value":{"id":"d77e6924-9bb7-4db0-addc-404442258f4b","created_at":"2022-11-30T14:16:22Z","updated_at":"2022-11-30T14:16:22Z","account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","type":"SERVICE_FEE","collection_amount":"12.41","processed_amount":{"cash_balance":"6.50","sell_to_cover":"0"},"currency":"EUR","status":"PROCESSING","period_start":"2022-11-01","period_end":"2022-11-30"},"id":"paths/~1fees~1collections/post/responses/200/content/application~1json/example"},"paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1fees~1collections/post/responses/400/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1collections/post/responses/401/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1collections/post/responses/403/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1fees~1collections/post/responses/404/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1collections/post/responses/406/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1collections/post/responses/429/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1collections/post/responses/500/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1collections/post/responses/503/content/application~1problem+json/example"},"paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1collections/post/responses/504/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example":{"value":{"id":"d77e6924-9bb7-4db0-addc-404442258f4b","created_at":"2022-11-30T14:16:22Z","updated_at":"2022-11-30T14:16:22Z","account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","type":"SERVICE_FEE","collection_amount":"12.41","processed_amount":{"cash_balance":"6.50","sell_to_cover":"0"},"currency":"EUR","status":"PROCESSING","period_start":"2022-11-01","period_end":"2022-11-30","calculation_breakdown":[{"fee_model_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subperiod_start":"2022-11-01","subperiod_end":"2022-11-30","subtotal_amount":"12.41","components":[{"type":"SERVICE","amount":"10.00"},{"type":"PLATFORM","amount":"2.41"}]}]},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/200/content/application~1json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1collections~1{fee_collection_id}/get/responses/504/content/application~1problem+json/example"},"paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2023-08-19T13:06:57.820371265Z","type":"FEE_COLLECTION.CREATED","webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","object":{"account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","collection_amount":"12.41","created_at":"2022-11-30T14:16:22Z","currency":"EUR","id":"d77e6924-9bb7-4db0-addc-404442258f4b","period_start":"2022-11-01","period_end":"2022-11-30","processed_amount":{"cash_balance":"0","sell_to_cover":"0"},"status":"PROCESSING","type":"SERVICE_FEE","updated_at":"2022-11-30T14:16:22Z"}},"key":"CREATED","summary":"CREATED","id":"paths/Fee collection events/post/requestBody/content/application~1json/examples/CREATED"},"paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED":{"value":{"id":"38fc59d0-fc42-46ef-9512-824773219b2e","created_at":"2023-08-19T13:06:57.820371265Z","type":"FEE_COLLECTION.FINALISED","webhook_id":"1b097e06-8a14-4181-b72a-de0972a3c57b","object":{"account_group_id":"999f7566-2ca3-4007-b99d-e501be8c7222","account_id":"689f7566-2ca3-4007-b99d-e501be8c7783","collection_amount":"12.41","created_at":"2022-11-30T14:16:22Z","currency":"EUR","id":"d77e6924-9bb7-4db0-addc-404442258f4b","period_start":"2022-11-01","period_end":"2022-11-30","processed_amount":{"cash_balance":"0","sell_to_cover":"0","total_residual_amount":"0.12"},"sell_to_cover_orders":[{"id":"1d0e329b-9c01-4dde-9883-5638d6319925","residual_amount":"0.00"},{"id":"8317dc2a-4073-437b-b27d-2c52f1e4c8b2","residual_amount":"0.12"}],"calculation_breakdown":[{"fee_model_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","subperiod_start":"2022-11-01","subperiod_end":"2022-11-30","subtotal_amount":"12.41","components":[{"type":"SERVICE","amount":"10.00"},{"type":"PLATFORM","amount":"2.41"}]}],"status":"FINALISED","type":"SERVICE_FEE","updated_at":"2022-11-30T14:16:22Z"}},"key":"FINALISED","summary":"FINALISED","id":"paths/Fee collection events/post/requestBody/content/application~1json/examples/FINALISED"},"paths/~1fees~1configurations/post/requestBody/content/application~1json/example":{"value":{"fee_model_id":"1df86975-06f4-484d-935e-46b54bab2f6c","account_id":"7524949b-31fd-497e-ad92-f52de45341d1"},"id":"paths/~1fees~1configurations/post/requestBody/content/application~1json/example"},"paths/~1fees~1configurations/post/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","fee_model_id":"1df86975-06f4-484d-935e-46b54bab2f6c","account_id":"7524949b-31fd-497e-ad92-f52de45341d1"},"id":"paths/~1fees~1configurations/post/responses/200/content/application~1json/example"},"paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1fees~1configurations/post/responses/400/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1configurations/post/responses/401/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1configurations/post/responses/403/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1fees~1configurations/post/responses/404/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1configurations/post/responses/406/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1fees~1configurations/post/responses/409/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1configurations/post/responses/429/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1configurations/post/responses/500/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1configurations/post/responses/503/content/application~1problem+json/example"},"paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1configurations/post/responses/504/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","account_id":"7524949b-31fd-497e-ad92-f52de45341d1","fee_model_id":"1df86975-06f4-484d-935e-46b54bab2f6c"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/200/content/application~1json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1configurations~1{account_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example":{"value":{"fee_model_id":"1df86975-06f4-484d-935e-46b54bab2f6c"},"id":"paths/~1fees~1configurations~1{account_id}/patch/requestBody/content/application~1json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example":{"value":{"created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","fee_model_id":"1df86975-06f4-484d-935e-46b54bab2f6c","account_id":"7524949b-31fd-497e-ad92-f52de45341d1"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/200/content/application~1json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/400/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/401/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/403/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/404/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/406/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/429/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/500/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/503/content/application~1problem+json/example"},"paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1fees~1configurations~1{account_id}/patch/responses/504/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models":{"value":{"meta":{"offset":0,"limit":100,"count":5,"total_count":5,"sort":"id","order":"ASC"},"data":[{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"absolute fee amount - flat fee model (only 1 tier specified)","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_amount":"10"}]},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"absolute fee amount - tiered fee model","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_amount":"10"},{"tier_id":"1","base_amount_from":"2000","fee_amount":"12"},{"tier_id":"2","base_amount_from":"4000","fee_amount":"14"}]},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"relative fee (bps) - flat fee model (only 1 tier specified)","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"RELATIVE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_bps":"100"}]},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"relative fee (bps) - tiered fee model with lower/upper bound","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"RELATIVE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_bps":"10","min_fee_amount":"10","max_fee_amount":"100"},{"tier_id":"1","base_amount_from":"2000","fee_bps":"12","min_fee_amount":"100","max_fee_amount":"1000"},{"tier_id":"2","base_amount_from":"4000","fee_bps":"14","min_fee_amount":"1000","max_fee_amount":"1111"}]},{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"relative fee (bps) with a minimum: for orders less than 10.000 1 EUR+1%, for orders more than 10.000 101 EUR+0,5%","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"RELATIVE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_bps":"0","min_fee_amount":"1"},{"tier_id":"1","base_amount_from":"0.01","fee_bps":"100"},{"tier_id":"2","base_amount_from":"10000","fee_bps":"0","min_fee_amount":"100"},{"tier_id":"3","base_amount_from":"10000.01","fee_bps":"50"}]}]},"key":"list_transaction_fee_models","summary":"List Transaction Fee Models","id":"paths/~1transaction_fees~1models/get/responses/200/content/application~1json/examples/list_transaction_fee_models"},"paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1transaction_fees~1models/get/responses/400/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1transaction_fees~1models/get/responses/401/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1transaction_fees~1models/get/responses/403/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1transaction_fees~1models/get/responses/404/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1transaction_fees~1models/get/responses/406/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1transaction_fees~1models/get/responses/409/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1transaction_fees~1models/get/responses/429/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1transaction_fees~1models/get/responses/500/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1transaction_fees~1models/get/responses/503/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1transaction_fees~1models/get/responses/504/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model":{"value":{"label":"transaction fee buy - new year promotion","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_amount":"10"},{"tier_id":"1","base_amount_from":"2000","fee_amount":"12"},{"tier_id":"2","base_amount_from":"4000","fee_amount":"14"}]},"key":"create_absolute_transaction_fee_model","summary":"Create Transaction Fee Model - Absolute","id":"paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_absolute_transaction_fee_model"},"paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model":{"value":{"label":"Tiered relative fee model with lower/upper bounds","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"RELATIVE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0.00","fee_bps":"300","min_fee_amount":"1.00"},{"tier_id":"1","base_amount_from":"5000.00","fee_bps":"250","min_fee_amount":"150.00"},{"tier_id":"2","base_amount_from":"10000.00","fee_bps":"200","min_fee_amount":"250.00","max_fee_amount":"300.00"}]},"key":"create_relative_transaction_fee_model","summary":"Create Transaction Fee Model - Relative","id":"paths/~1transaction_fees~1models/post/requestBody/content/application~1json/examples/create_relative_transaction_fee_model"},"paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"transaction fee buy - new year promotion","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_amount":"10"},{"tier_id":"1","base_amount_from":"2000","fee_amount":"12"},{"tier_id":"2","base_amount_from":"4000","fee_amount":"14"}]},"key":"create_absolute_transaction_fee_model","summary":"Create Transaction Fee Model - Absolute","id":"paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_absolute_transaction_fee_model"},"paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"Tiered relative fee model with lower/upper bounds","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"RELATIVE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0.00","fee_bps":"300","min_fee_amount":"1.00"},{"tier_id":"1","base_amount_from":"5000.00","fee_bps":"250","min_fee_amount":"150.00"},{"tier_id":"2","base_amount_from":"10000.00","fee_bps":"200","min_fee_amount":"250.00","max_fee_amount":"300.00"}]},"key":"create_relative_transaction_fee_model","summary":"Create Transaction Fee Model - Relative","id":"paths/~1transaction_fees~1models/post/responses/200/content/application~1json/examples/create_relative_transaction_fee_model"},"paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1transaction_fees~1models/post/responses/400/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1transaction_fees~1models/post/responses/401/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1transaction_fees~1models/post/responses/403/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1transaction_fees~1models/post/responses/404/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1transaction_fees~1models/post/responses/406/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1transaction_fees~1models/post/responses/409/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1transaction_fees~1models/post/responses/429/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1transaction_fees~1models/post/responses/500/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1transaction_fees~1models/post/responses/503/content/application~1problem+json/example"},"paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1transaction_fees~1models/post/responses/504/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"transaction fee buy - new year promotion","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_amount":"10"},{"tier_id":"1","base_amount_from":"2000","fee_amount":"12"},{"tier_id":"2","base_amount_from":"4000","fee_amount":"14"}]},"key":"retrieve_absolute_transaction_fee_model","summary":"Get Transaction Fee Model - Absolute","id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"transaction fee buy - new year promotion","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"100","fee_amount":"10"}]},"key":"retrieve_absolute_transaction_fee_model_with_one_tier","summary":"Get Transaction Fee Model - Absolute - With One Tier","id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_absolute_transaction_fee_model_with_one_tier"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model":{"value":{"id":"eb5ba93f-5dfe-4bf1-8571-4da0caacc80c","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","label":"transaction fee buy - new year promotion","currency":"EUR","charge_method":"CHARGED_BY_CLIENT","value_type":"ABSOLUTE","application_type":"VOLUME","base_amount_scope":"ORDER","tiers":[{"tier_id":"0","base_amount_from":"0","fee_bps":"100","min_fee_amount":"5","max_fee_amount":"15"},{"tier_id":"1","base_amount_from":"2000","fee_bps":"200","min_cash_amount":"15","max_cash_amount":"100"},{"tier_id":"2","base_amount_from":"4000","fee_bps":"300","min_fee_amount":"100","max_fee_amount":"200"}]},"key":"retrieve_relative_transaction_fee_model","summary":"Get Transaction Fee Model - Relative","id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/200/content/application~1json/examples/retrieve_relative_transaction_fee_model"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example":{"value":{"status":409,"type":"conflict"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/409/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1transaction_fees~1models~1{transaction_fee_model_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"CORPORATE_ACTION_CASH_TRANSACTION","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"},"references":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","type":"CORPORATE_ACTION_TRANSACTION_ID"}]}}]},"id":"paths/~1users~1{user_id}~1reports/get/responses/200/content/application~1json/example"},"paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1users~1{user_id}~1reports/get/responses/400/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1users~1{user_id}~1reports/get/responses/401/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1users~1{user_id}~1reports/get/responses/403/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1users~1{user_id}~1reports/get/responses/404/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1users~1{user_id}~1reports/get/responses/406/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1users~1{user_id}~1reports/get/responses/429/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1users~1{user_id}~1reports/get/responses/500/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1users~1{user_id}~1reports/get/responses/503/content/application~1problem+json/example"},"paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1users~1{user_id}~1reports/get/responses/504/content/application~1problem+json/example"},"paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost":{"value":{"type":"ORDER_EX_ANTE_COST","order":{"business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"SELL","instrument_id":"LU0274208692","instrument_id_type":"ISIN","currency":"EUR","cash_amount":"1000.00"},"fees":[{"type":"TRANSACTION_FEE_BUY","value_type":"ABSOLUTE","cash_amount":"1.00","currency":"EUR"},{"type":"TRANSACTION_FEE_SELL","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c111"},{"type":"ANNUAL_AUM_BASED_FEE","value_type":"RELATIVE","bps":"10"}]},"key":"business-nominal-sell-order-ex-ante-cost","summary":"Business - nominal sell order ex-ante cost report","id":"paths/~1reports/post/requestBody/content/application~1json/examples/business-nominal-sell-order-ex-ante-cost"},"paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost":{"value":{"type":"ORDER_EX_ANTE_COST","order":{"business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","instrument_id":"LU0274208692","instrument_id_type":"ISIN","currency":"EUR","quantity":"15"},"fees":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"},{"type":"TRANSACTION_FEE_SELL","value_type":"ABSOLUTE","cash_amount":"0.95","currency":"EUR"},{"type":"ANNUAL_AUM_BASED_FEE","value_type":"RELATIVE","bps":"37"}],"inducements":[{"value_type":"ABSOLUTE","cash_amount":"0.10","currency":"EUR"}]},"key":"business-unit-buy-order-ex-ante-cost","summary":"Business - unit buy order ex-ante cost report","id":"paths/~1reports/post/requestBody/content/application~1json/examples/business-unit-buy-order-ex-ante-cost"},"paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost":{"value":{"type":"ORDER_EX_ANTE_COST","order":{"user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"SELL","instrument_id":"LU0274208692","instrument_id_type":"ISIN","currency":"EUR","cash_amount":"1000.00"},"fees":[{"type":"TRANSACTION_FEE_BUY","value_type":"ABSOLUTE","cash_amount":"1.00","currency":"EUR"},{"type":"TRANSACTION_FEE_SELL","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c111"},{"type":"ANNUAL_AUM_BASED_FEE","value_type":"RELATIVE","bps":"10"}]},"key":"nominal-sell-order-ex-ante-cost","summary":"Nominal sell order ex-ante cost report","id":"paths/~1reports/post/requestBody/content/application~1json/examples/nominal-sell-order-ex-ante-cost"},"paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost":{"value":{"type":"ORDER_EX_ANTE_COST_SAVINGS_PLAN","order":{"user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","cash_amount":"1000.00","currency":"EUR","side":"BUY","instrument_id":"LU0274208692","instrument_id_type":"ISIN","order_type":"MARKET","period":"WEEK","interval":"2"},"fees":[{"type":"TRANSACTION_FEE_BUY","value_type":"ABSOLUTE","cash_amount":"0.80","currency":"EUR"},{"type":"TRANSACTION_FEE_SELL","value_type":"ABSOLUTE","cash_amount":"0.95","currency":"EUR"},{"type":"ANNUAL_AUM_BASED_FEE","value_type":"RELATIVE","bps":"37"}],"inducements":[{"value_type":"ABSOLUTE","cash_amount":"0.10","currency":"EUR"}]},"key":"savings-plan-ex-ante-cost","summary":"Savings plan ex-ante cost report","id":"paths/~1reports/post/requestBody/content/application~1json/examples/savings-plan-ex-ante-cost"},"paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost":{"value":{"type":"ORDER_EX_ANTE_COST","order":{"user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","instrument_id":"LU0274208692","instrument_id_type":"ISIN","currency":"EUR","quantity":"15"},"fees":[{"type":"TRANSACTION_FEE_BUY","transaction_fee_model_id":"eb5ba93f-5dfe-4bf1-84da-0caacc80c000"},{"type":"TRANSACTION_FEE_SELL","value_type":"ABSOLUTE","cash_amount":"0.95","currency":"EUR"},{"type":"ANNUAL_AUM_BASED_FEE","value_type":"RELATIVE","bps":"37"}],"inducements":[{"value_type":"ABSOLUTE","cash_amount":"0.10","currency":"EUR"}]},"key":"unit-buy-order-ex-ante-cost","summary":"Unit buy order ex-ante cost report","id":"paths/~1reports/post/requestBody/content/application~1json/examples/unit-buy-order-ex-ante-cost"},"paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2023-08-24T14:15:22Z","business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"ORDER_EX_ANTE_COST","substituted_report_id":null,"data":{"account":{"id":"c5034305-c441-4711-adbf-93cfbc13a695","account_number":1},"account_group":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","securities_account_number":"123456789"},"business":{"company_name":"Acme Corporation","address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","country":"DE"}},"instrument":{"isin":"LU0274208692","short_name":"XTR.MSCI WORLD SWAP 1C"},"venue":{"name":"Tradegate"},"order":{"business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","instrument_id":"LU0274208692","instrument_id_type":"ISIN","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","quantity":"15","cash_amount":"1220.85","currency":"EUR","price":"81.39"},"holding_period":{"unit":"YEAR","quantity":3},"total_cost":{"product":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"},"service":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"},"third_party":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"total":{"cash_amount":"25.06","currency":"EUR","as_percentage":"2.05"}},"product_cost":{"one_off":{"cash_amount":"0.20","currency":"EUR","as_percentage":"0.02"},"ongoing":{"cash_amount":"16.48","currency":"EUR","as_percentage":"1.35"},"transaction":{"cash_amount":"0.80","currency":"EUR","as_percentage":"0.07"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"}},"service_cost":{"one_off":{"cash_amount":"0.49","currency":"EUR","as_percentage":"0.04"},"ongoing":{"cash_amount":"4.39","currency":"EUR","as_percentage":"0.36"},"transaction":{"cash_amount":"2.00","currency":"EUR","as_percentage":"0.16"},"ancillary":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"}},"third_party_payments":{"total":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"received_by_client":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"},"received_by_upvest":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"}},"return_impact":{"year_one":{"cash_amount":"9.05","currency":"EUR","as_percentage":"0.74"},"year_two":{"cash_amount":"6.96","currency":"EUR","as_percentage":"0.57"},"year_three":{"cash_amount":"8.36","currency":"EUR","as_percentage":"0.68"}}}},"key":"business-order-ex-ante-cost","summary":"Business order ex-ante cost report","id":"paths/~1reports/post/responses/200/content/application~1json/examples/business-order-ex-ante-cost"},"paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2023-08-24T14:15:22Z","user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"ORDER_EX_ANTE_COST","substituted_report_id":null,"data":{"account":{"id":"c5034305-c441-4711-adbf-93cfbc13a695","account_number":1},"account_group":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","securities_account_number":"123456789"},"user":{"salutation":"SALUTATION_MALE","title":"DR","first_name":"Karl","last_name":"Schmidt","address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","country":"DE"}},"instrument":{"isin":"LU0274208692","short_name":"XTR.MSCI WORLD SWAP 1C"},"venue":{"name":"Tradegate"},"order":{"user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","instrument_id":"LU0274208692","instrument_id_type":"ISIN","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","quantity":"15","cash_amount":"1220.85","currency":"EUR","price":"81.39"},"holding_period":{"unit":"YEAR","quantity":3},"total_cost":{"product":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"},"service":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"},"third_party":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"total":{"cash_amount":"25.06","currency":"EUR","as_percentage":"2.05"}},"product_cost":{"one_off":{"cash_amount":"0.20","currency":"EUR","as_percentage":"0.02"},"ongoing":{"cash_amount":"16.48","currency":"EUR","as_percentage":"1.35"},"transaction":{"cash_amount":"0.80","currency":"EUR","as_percentage":"0.07"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"}},"service_cost":{"one_off":{"cash_amount":"0.49","currency":"EUR","as_percentage":"0.04"},"ongoing":{"cash_amount":"4.39","currency":"EUR","as_percentage":"0.36"},"transaction":{"cash_amount":"2.00","currency":"EUR","as_percentage":"0.16"},"ancillary":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"}},"third_party_payments":{"total":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"received_by_client":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"},"received_by_upvest":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"}},"return_impact":{"year_one":{"cash_amount":"9.05","currency":"EUR","as_percentage":"0.74"},"year_two":{"cash_amount":"6.96","currency":"EUR","as_percentage":"0.57"},"year_three":{"cash_amount":"8.36","currency":"EUR","as_percentage":"0.68"}}}},"key":"order-ex-ante-cost","summary":"Order ex-ante cost report","id":"paths/~1reports/post/responses/200/content/application~1json/examples/order-ex-ante-cost"},"paths/~1reports/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1reports/post/responses/400/content/application~1problem+json/example"},"paths/~1reports/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1reports/post/responses/401/content/application~1problem+json/example"},"paths/~1reports/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1reports/post/responses/403/content/application~1problem+json/example"},"paths/~1reports/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1reports/post/responses/404/content/application~1problem+json/example"},"paths/~1reports/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1reports/post/responses/406/content/application~1problem+json/example"},"paths/~1reports/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1reports/post/responses/429/content/application~1problem+json/example"},"paths/~1reports/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1reports/post/responses/500/content/application~1problem+json/example"},"paths/~1reports/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1reports/post/responses/503/content/application~1problem+json/example"},"paths/~1reports/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1reports/post/responses/504/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2023-08-24T14:15:22Z","business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"ORDER_EX_ANTE_COST","substituted_report_id":null,"data":{"account":{"id":"c5034305-c441-4711-adbf-93cfbc13a695","account_number":1},"account_group":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","securities_account_number":"123456789"},"business":{"company_name":"Acme Corporation","address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","country":"DE"}},"instrument":{"isin":"LU0274208692","short_name":"XTR.MSCI WORLD SWAP 1C"},"venue":{"name":"Tradegate"},"order":{"business_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","instrument_id":"LU0274208692","instrument_id_type":"ISIN","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","quantity":"15","cash_amount":"1220.85","currency":"EUR","price":"81.39"},"holding_period":{"unit":"YEAR","quantity":3},"total_cost":{"product":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"},"service":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"},"third_party":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"total":{"cash_amount":"25.06","currency":"EUR","as_percentage":"2.05"}},"product_cost":{"one_off":{"cash_amount":"0.20","currency":"EUR","as_percentage":"0.02"},"ongoing":{"cash_amount":"16.48","currency":"EUR","as_percentage":"1.35"},"transaction":{"cash_amount":"0.80","currency":"EUR","as_percentage":"0.07"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"}},"service_cost":{"one_off":{"cash_amount":"0.49","currency":"EUR","as_percentage":"0.04"},"ongoing":{"cash_amount":"4.39","currency":"EUR","as_percentage":"0.36"},"transaction":{"cash_amount":"2.00","currency":"EUR","as_percentage":"0.16"},"ancillary":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"}},"third_party_payments":{"total":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"received_by_client":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"},"received_by_upvest":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"}},"return_impact":{"year_one":{"cash_amount":"9.05","currency":"EUR","as_percentage":"0.74"},"year_two":{"cash_amount":"6.96","currency":"EUR","as_percentage":"0.57"},"year_three":{"cash_amount":"8.36","currency":"EUR","as_percentage":"0.68"}}}},"key":"business-order-ex-ante-cost","summary":"Business order ex-ante cost report","id":"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-order-ex-ante-cost"},"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2023-08-24T14:15:22Z","user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"ORDER_EX_ANTE_COST","substituted_report_id":null,"data":{"account":{"id":"c5034305-c441-4711-adbf-93cfbc13a695","account_number":1},"account_group":{"id":"9d95820d-4333-46b6-98de-04ab7512e76f","securities_account_number":"123456789"},"user":{"salutation":"SALUTATION_MALE","title":"DR","first_name":"Karl","last_name":"Schmidt","address":{"address_line1":"Rosenweg 221","address_line2":"apt. 33","postcode":"45678","city":"Berlin","country":"DE"}},"instrument":{"isin":"LU0274208692","short_name":"XTR.MSCI WORLD SWAP 1C"},"venue":{"name":"Tradegate"},"order":{"user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","instrument_id":"LU0274208692","instrument_id_type":"ISIN","account_id":"c5034305-c441-4711-adbf-93cfbc13a695","order_type":"MARKET","side":"BUY","quantity":"15","cash_amount":"1220.85","currency":"EUR","price":"81.39"},"holding_period":{"unit":"YEAR","quantity":3},"total_cost":{"product":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"},"service":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"},"third_party":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"total":{"cash_amount":"25.06","currency":"EUR","as_percentage":"2.05"}},"product_cost":{"one_off":{"cash_amount":"0.20","currency":"EUR","as_percentage":"0.02"},"ongoing":{"cash_amount":"16.48","currency":"EUR","as_percentage":"1.35"},"transaction":{"cash_amount":"0.80","currency":"EUR","as_percentage":"0.07"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"17.48","currency":"EUR","as_percentage":"1.43"}},"service_cost":{"one_off":{"cash_amount":"0.49","currency":"EUR","as_percentage":"0.04"},"ongoing":{"cash_amount":"4.39","currency":"EUR","as_percentage":"0.36"},"transaction":{"cash_amount":"2.00","currency":"EUR","as_percentage":"0.16"},"ancillary":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"incidental":{"cash_amount":"0.00","currency":"EUR","as_percentage":"0.00"},"total":{"cash_amount":"6.88","currency":"EUR","as_percentage":"0.56"}},"third_party_payments":{"total":{"cash_amount":"0.70","currency":"EUR","as_percentage":"0.06"},"received_by_client":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"},"received_by_upvest":{"cash_amount":"0.35","currency":"EUR","as_percentage":"0.03"}},"return_impact":{"year_one":{"cash_amount":"9.05","currency":"EUR","as_percentage":"0.74"},"year_two":{"cash_amount":"6.96","currency":"EUR","as_percentage":"0.57"},"year_three":{"cash_amount":"8.36","currency":"EUR","as_percentage":"0.68"}}}},"key":"order-ex-ante-cost","summary":"Order ex-ante cost report","id":"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/order-ex-ante-cost"},"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"BUY_ORDER","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"}}},"key":"report","summary":"Report","id":"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/report"},"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report":{"value":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","business_id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","type":"BUY_ORDER","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"}}},"key":"business-report","summary":"Business report","id":"paths/~1reports~1{report_id}/get/responses/200/content/application~1json/examples/business-report"},"paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1reports~1{report_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1reports~1{report_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1reports~1{report_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1reports~1{report_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1reports~1{report_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1reports~1{report_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1reports~1{report_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1reports~1{report_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","business_id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","type":"CORPORATE_ACTION_CASH_TRANSACTION","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"},"references":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","type":"CORPORATE_ACTION_TRANSACTION_ID"}]}}]},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/200/content/application~1json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/400/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/401/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/403/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/404/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/406/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/429/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/500/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/503/content/application~1problem+json/example"},"paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1businesses~1{business_id}~1reports/get/responses/504/content/application~1problem+json/example"},"paths/Reports events/post/requestBody/content/application~1json/examples/user_report":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"REPORT.CREATED","object":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","user_id":"d1a4be99-8bb6-4e78-b897-8168f6823ab5","type":"CORPORATE_ACTION_CASH_TRANSACTION","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"},"references":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","type":"CORPORATE_ACTION_TRANSACTION_ID"}]}},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"user_report","summary":"User report","id":"paths/Reports events/post/requestBody/content/application~1json/examples/user_report"},"paths/Reports events/post/requestBody/content/application~1json/examples/business_report":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2021-07-21T14:10:00.00Z","type":"REPORT.CREATED","object":{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","created_at":"2020-08-24T14:15:22Z","business_id":"a9a72268-4f3c-4de2-abb9-a553a3bb7608","type":"CORPORATE_ACTION_CASH_TRANSACTION","substituted_report_id":null,"data":{"account":{"id":"a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"},"references":[{"id":"b96b1ee7-d491-43eb-b5e4-4833af9c9c2f","type":"CORPORATE_ACTION_TRANSACTION_ID"}]}},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"key":"business_report","summary":"Business report","id":"paths/Reports events/post/requestBody/content/application~1json/examples/business_report"},"paths/Treasury reports events/post/requestBody/content/application~1json/example":{"value":{"id":"8962b496-8d42-4560-bfab-10490dd1a721","created_at":"2023-05-08T10:42:34.758Z","type":"TREASURY_REPORT.CREATED","object":{"id":"6e736b54-ed57-46ad-8620-0ef59ddd8e6d","type":"TRADING","currency":"EUR","settlement_amount":"123.12","report_date":"2023-05-08","direction":"OUTGOING","filename":"buy_trading_05082023.csv"},"webhook_id":"9df39835-be87-4243-9018-f2500b39cee6"},"id":"paths/Treasury reports events/post/requestBody/content/application~1json/example"},"paths/~1transactions~1cash/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"booking_date","order":"ASC"},"data":[{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-305.00","currency":"EUR"},"taxes":[{"amount":"5.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"5.00","currency":"EUR"},"tax_breakdown":[{"amount":"5.00","currency":"EUR","type":"FINANCIAL_TRANSACTION_TAX","taxing_jurisdiction":"FR"}]},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},{"id":"9e7a3188-eff8-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"SEPA_DIRECT_DEBIT","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"100.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"98f01200-eff8-11ed-a05b-0242ac120003","type":"DIRECT_DEBIT"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"}]},"id":"paths/~1transactions~1cash/get/responses/200/content/application~1json/example"},"paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1transactions~1cash/get/responses/400/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1transactions~1cash/get/responses/401/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1transactions~1cash/get/responses/403/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1transactions~1cash/get/responses/404/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1transactions~1cash/get/responses/405/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1transactions~1cash/get/responses/406/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1transactions~1cash/get/responses/429/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1transactions~1cash/get/responses/500/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1transactions~1cash/get/responses/503/content/application~1problem+json/example"},"paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1transactions~1cash/get/responses/504/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"booking_date","order":"ASC"},"data":[{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_id":"db6290bb-1491-45bf-aafe-262dad59d497","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"-2.5234543879"},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION_CANCELLATION","account_id":"db6290bb-1491-45bf-aafe-262dad59d497","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"2.5234543879"},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"}]},"id":"paths/~1transactions~1securities/get/responses/200/content/application~1json/example"},"paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1transactions~1securities/get/responses/400/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1transactions~1securities/get/responses/401/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1transactions~1securities/get/responses/403/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1transactions~1securities/get/responses/404/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example":{"value":{"status":405,"type":"method_not_allowed"},"id":"paths/~1transactions~1securities/get/responses/405/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1transactions~1securities/get/responses/406/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1transactions~1securities/get/responses/429/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1transactions~1securities/get/responses/500/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1transactions~1securities/get/responses/503/content/application~1problem+json/example"},"paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1transactions~1securities/get/responses/504/content/application~1problem+json/example"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend":{"value":{"id":"55a877ce-effa-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"CASH_DIVIDEND","account_id":"0255e6c4-effa-11ed-a05b-0242ac120003","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"25.00","currency":"EUR"},"taxes":[{"amount":"2.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"2.00","currency":"EUR"},"tax_breakdown":[{"amount":"0.50","currency":"EUR","type":"INTERNATIONAL_WITHHOLDING_TAX","taxing_jurisdiction":"FR"},{"amount":"0.20","currency":"EUR","type":"CAPITAL_GAINS","taxing_jurisdiction":"FR"},{"amount":"0.80","currency":"EUR","type":"SOLIDARITY_SURCHARGE","taxing_jurisdiction":"DE"},{"amount":"0.50","currency":"EUR","type":"CHURCH_TAX","taxing_jurisdiction":"DE"}]},"references":[{"id":"c29a9ee8-ed64-11ef-a2e4-2eabd0c03f8a","type":"CORPORATE_ACTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"CORPORATE_ACTION_TRANSACTION_ID"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"9d3ac2e0-effa-11ed-a05b-0242ac120003"},"key":"cash_dividend","summary":"Cash Dividend","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation":{"value":{"id":"e23218bc-effa-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"dafd9954-effa-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"CASH_DIVIDEND_CANCELLATION","account_id":"0255e6c4-effa-11ed-a05b-0242ac120003","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"-25.00","currency":"EUR"},"taxes":[{"amount":"-2.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"-2.00","currency":"EUR"},"tax_breakdown":[{"amount":"-0.50","currency":"EUR","type":"INTERNATIONAL_WITHHOLDING_TAX","taxing_jurisdiction":"FR"},{"amount":"-0.20","currency":"EUR","type":"CAPITAL_GAINS","taxing_jurisdiction":"FR"},{"amount":"-0.80","currency":"EUR","type":"SOLIDARITY_SURCHARGE","taxing_jurisdiction":"DE"},{"amount":"-0.50","currency":"EUR","type":"CHURCH_TAX","taxing_jurisdiction":"DE"}]},"references":[{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"CORPORATE_ACTION_TRANSACTION_ID"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"d68273ae-effa-11ed-a05b-0242ac120003"},"key":"cash_dividend_cancellation","summary":"Cash Dividend Cancellation","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/cash_dividend_cancellation"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-104.00","currency":"EUR"},"taxes":[{"amount":"4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"4.00","currency":"EUR"},"tax_breakdown":[{"amount":"4.00","currency":"EUR","type":"FINANCIAL_TRANSACTION_TAX","taxing_jurisdiction":"FR"}]},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"35701970-effb-11ed-a05b-0242ac120003"},"key":"buy_order_execution","summary":"Buy Order Execution","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-104.00","currency":"EUR"},"taxes":[{"amount":"4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"4.00","currency":"EUR"},"tax_breakdown":[{"amount":"4.00","currency":"EUR","type":"FINANCIAL_TRANSACTION_TAX","taxing_jurisdiction":"FR"}]},"fees":[{"amount":"1.00","currency":"EUR","type":"TOTAL","charge_method":"CHARGED_BY_CLIENT"}],"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"35701970-effb-11ed-a05b-0242ac120003"},"key":"buy_order_execution_with_fees_charged_by_client","summary":"Buy Order Execution with fees charged by client","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_charged_by_client"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-105.00","currency":"EUR"},"taxes":[{"amount":"4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"4.00","currency":"EUR"},"tax_breakdown":[{"amount":"4.00","currency":"EUR","type":"FINANCIAL_TRANSACTION_TAX","taxing_jurisdiction":"FR"}]},"fees":[{"amount":"1.00","currency":"EUR","type":"TOTAL","charge_method":"COLLECTED_BY_UPVEST"}],"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"},{"id":"6add5e16-79eb-11f0-8944-3aa3573bef52","type":"TRANSACTION_FEE_EXECUTION"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"35701970-effb-11ed-a05b-0242ac120003"},"key":"buy_order_execution_with_fees_collected_by_upvest","summary":"Buy Order Execution with fees charged by client and collected by Upvest","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_with_fees_collected_by_upvest"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation":{"value":{"id":"1dac4156-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"25c56ab6-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION_CANCELLATION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"104.00","currency":"EUR"},"taxes":[{"amount":"-4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"-4.00","currency":"EUR"},"tax_breakdown":[{"amount":"-4.00","currency":"EUR","type":"FINANCIAL_TRANSACTION_TAX","taxing_jurisdiction":"FR"}]},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"162db946-effb-11ed-a05b-0242ac120003"},"key":"buy_order_execution_cancellation","summary":"Buy Order Execution Cancellation","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/buy_order_execution_cancellation"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"96.00","currency":"EUR"},"taxes":[{"amount":"4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"4.00","currency":"EUR"},"tax_breakdown":[{"amount":"1.50","currency":"EUR","type":"SOLIDARITY_SURCHARGE","taxing_jurisdiction":"DE"},{"amount":"0.50","currency":"EUR","type":"CHURCH_TAX","taxing_jurisdiction":"DE"},{"amount":"2.00","currency":"EUR","type":"CAPITAL_GAINS","taxing_jurisdiction":"DE"}]},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"35701970-effb-11ed-a05b-0242ac120003"},"key":"sell_order_execution","summary":"Sell Order Execution","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation":{"value":{"id":"1dac4156-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"25c56ab6-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION_CANCELLATION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-96.00","currency":"EUR"},"taxes":[{"amount":"-4.00","currency":"EUR","type":"TOTAL"}],"taxes_details":{"total_amount":{"amount":"-4.00","currency":"EUR"},"tax_breakdown":[{"amount":"-1.50","currency":"EUR","type":"SOLIDARITY_SURCHARGE","taxing_jurisdiction":"DE"},{"amount":"-0.50","currency":"EUR","type":"CHURCH_TAX","taxing_jurisdiction":"DE"},{"amount":"-2.00","currency":"EUR","type":"CAPITAL_GAINS","taxing_jurisdiction":"DE"}]},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"162db946-effb-11ed-a05b-0242ac120003"},"key":"sell_order_execution_cancellation","summary":"Sell Order Execution Cancellation","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sell_order_execution_cancellation"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection":{"value":{"id":"1d27576e-f4a3-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"2349857c-f4a3-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"FEE_COLLECTION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-10.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"17c36d9e-f4a3-11ed-a05b-0242ac120003","type":"FEE_COLLECTION"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"1216067c-f4a3-11ed-a05b-0242ac120003"},"key":"fee_collection","summary":"Fee Collection","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation":{"value":{"id":"3cdfad72-f4a3-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"2349857c-f4a3-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"FEE_COLLECTION_CANCELLATION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"10.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"45d15c46-f4a3-11ed-a05b-0242ac120003","type":"FEE_COLLECTION"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"40fb1252-f4a3-11ed-a05b-0242ac120003"},"key":"fee_collection_cancellation","summary":"Fee Collection Cancellation","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/fee_collection_cancellation"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit":{"value":{"id":"a9a76224-eff8-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"9e7a3188-eff8-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"SEPA_DIRECT_DEBIT","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"305.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"98f01200-eff8-11ed-a05b-0242ac120003","type":"DIRECT_DEBIT"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"9390c822-eff8-11ed-a05b-0242ac120003"},"key":"sepa_direct_debit","summary":"Sepa Direct Debit","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback":{"value":{"id":"2e471146-eff9-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"23547364-eff9-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"SEPA_DIRECT_DEBIT_CHARGE_BACK","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-305.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"1d2a347e-eff9-11ed-a05b-0242ac120003","type":"DIRECT_DEBIT"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"060844b6-eff9-11ed-a05b-0242ac120003"},"key":"sepa_direct_debit_chargeback","summary":"Sepa Direct Debit Chargeback","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/sepa_direct_debit_chargeback"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup":{"value":{"id":"e619bf74-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"e165c4b4-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"TOPUP","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"100.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"dbf4d0a6-effb-11ed-a05b-0242ac120003","type":"TOPUP"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"d53b06f4-effb-11ed-a05b-0242ac120003"},"key":"topup","summary":"Top-up","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/topup"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"WITHDRAWAL","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"-305.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"WITHDRAWAL"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"7eea34e2-8835-11ed-a47e-2eabd0c03f8a"},"key":"withdrawal","summary":"Withdrawal","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation":{"value":{"id":"10cabec6-effc-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"15750eae-effc-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"WITHDRAWAL_CANCELLATION","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"305.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"1cffa512-effc-11ed-a05b-0242ac120003","type":"WITHDRAWAL"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"0d0edd62-effc-11ed-a05b-0242ac120003"},"key":"withdrawal_cancellation","summary":"Withdrawal Cancellation","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/withdrawal_cancellation"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer":{"value":{"id":"e619bf74-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"e165c4b4-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"INTERNAL_CASH_TRANSFER","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"100.00","currency":"EUR"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"EUR"},"tax_breakdown":[]},"references":[{"id":"dbf4d0a6-effb-11ed-a05b-0242ac120003","type":"ACCOUNT_GROUP"},{"id":"1a9c7e2b-3f4d-4e5a-8b6c-7d8e9f0a1b2c","type":"CASH_BALANCE_TRANSFER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"d53b06f4-effb-11ed-a05b-0242ac120003"},"key":"internal_cash_transfer","summary":"Internal Cash Transfer","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/internal_cash_transfer"},"paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer":{"value":{"id":"e619bf74-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"CASH_TRANSACTION.EXECUTED","object":{"id":"e165c4b4-effb-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ISA_TRANSFER","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","delta":{"amount":"100.00","currency":"GBP"},"taxes":[],"taxes_details":{"total_amount":{"amount":"0.00","currency":"GBP"},"tax_breakdown":[]},"references":[{"id":"dbf4d0a6-effb-11ed-a05b-0242ac120003","type":"ISA_TRANSFER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"d53b06f4-effb-11ed-a05b-0242ac120003"},"key":"isa_transfer","summary":"ISA Transfer","id":"paths/Cash transactions events/post/requestBody/content/application~1json/examples/isa_transfer"},"paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution":{"value":{"id":"543c9996-eff6-11ed-a05b-0242ac120003","created_at":"2023-01-01T00:00:00.000Z","type":"SECURITY_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION","account_id":"db6290bb-1491-45bf-aafe-262dad59d497","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"-2.5234543879"},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"3ae8a8a4-eff6-11ed-a05b-0242ac120003"},"key":"order_execution","summary":"Order Execution","id":"paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution"},"paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation":{"value":{"id":"398278e2-8835-11ed-97e3-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","type":"SECURITY_TRANSACTION.EXECUTED","object":{"id":"6dc9fbca-8835-11ed-a217-2eabd0c03f8a","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"ORDER_EXECUTION_CANCELLATION","account_id":"db6290bb-1491-45bf-aafe-262dad59d497","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"2.5234543879"},"references":[{"id":"7579a672-8835-11ed-9455-2eabd0c03f8a","type":"ORDER_EXECUTION"},{"id":"1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a","type":"ORDER"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"fd9690e2-effa-11ed-a05b-0242ac120003"},"key":"order_execution_cancellation","summary":"Order Execution Cancellation","id":"paths/Security transactions events/post/requestBody/content/application~1json/examples/order_execution_cancellation"},"paths/Security transactions events/post/requestBody/content/application~1json/examples/merger":{"value":{"id":"71478127-4688-46b6-b3c6-871febb20330","created_at":"2023-01-01T00:00:00.000Z","type":"SECURITY_TRANSACTION.EXECUTED","object":{"id":"f0f6834a-ddc8-4ef4-b4e2-025a6bbd1cf1","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","type":"MERGER","account_id":"db6290bb-1491-45bf-aafe-262dad59d497","account_group_id":"6409e3f2-8835-11ed-96a4-2eabd0c03f8a","instrument":{"uuid":"ccb86937-8a39-4160-8d33-85bf9e902321","isin":"US0378331005"},"delta":{"amount":"32.52"},"references":[{"id":"7f3a087b-2934-40f0-a311-caab2e449d9b","type":"CORPORATE_ACTION"},{"id":"f29af46d-d424-4b87-b656-ab2cb46e460c","type":"CORPORATE_ACTION_TRANSACTION_ID"}],"booking_date":"2023-01-01T00:00:00.000Z","value_date":"2023-01-01T00:00:00.000Z"},"webhook_id":"52a47a86-8805-43be-b631-d79e67bb5da9"},"key":"merger","summary":"Merger","id":"paths/Security transactions events/post/requestBody/content/application~1json/examples/merger"},"paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example":{"value":{"id":"d588e071-6e02-4ae6-a2b6-a5f08499633b","created_at":"2024-03-04T08:24:18Z","updated_at":"2024-03-14T11:18:39Z","signed_url":"https://storage.googleapis.com/upvest-tooling-datasharing-service-ia-unstable-7263/477ed9c4943c47f235712a1e80c1ef8491768f0a31ed2d81f244dfebe418e909/tats-tests-encrypted-text.txt?Expires=1710415438&GoogleAccessId=tooling-datasharing-service%40ia-unstable-7263.iam.gserviceaccount.com&Signature=cxb7JQXJVfO6ltBK%2FCWJkzoQcONakNiVsitn0nwtLDJmBj4cznBbMnT0yKtIO4v7BjhR92JmUd9wm7MurZYcuxdBPTMk%2BLTl0KN3QMEJ7%2FVjM1zSerIOxQ8OLFWCswt16Fj9%2BpwD7ZMplIrSEBGijPD48gLlZF%2FTW4yPqkLbE6sYn5Kn3K9A%2B3iF7%2BUaljQ2jLTxG9vCapp8WKjGjDyDXRtDDYY7OXJ6aDrjxDEUxO6kkOGzxMEBCALoHjD2lMpkEy5Gp1BkUbPka7hYVrbQrDM1xpBRsq%2F%2FCT%2F%2Bt196e8JP9YGr%2FxeA%2Bqt6ZTTryzGZhHlvHJFjqIqj2Ip7HioFjw%3D%3D","file_name":"tats-tests-encrypted-text.txt","content_length":919,"checksum":"709b190a108791217f62d839f85a7a997c2039cc29a737d59fd50454b85b2956"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/200/content/application~1json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/400/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/401/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/403/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/404/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/406/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/429/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/500/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/503/content/application~1problem+json/example"},"paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1files~1{folder}~1{file_name}/get/responses/504/content/application~1problem+json/example"},"paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming":{"value":{"direction":"INCOMING","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","transfer_type":"NO_OWNER_CHANGE","settlement_reference":"b82dc5985558fdr2","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5"}],"counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"key":"incoming","summary":"INCOMING","id":"paths/~1account_transfers/post/requestBody/content/application~1json/examples/incoming"},"paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing":{"value":{"direction":"OUTGOING","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","transfer_type":"NO_OWNER_CHANGE","settlement_reference":"b82dc5985558fdr2","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5"}],"counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"key":"outgoing","summary":"OUTGOING","id":"paths/~1account_transfers/post/requestBody/content/application~1json/examples/outgoing"},"paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming":{"value":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"NEW","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"key":"incoming","summary":"INCOMING","id":"paths/~1account_transfers/post/responses/200/content/application~1json/examples/incoming"},"paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing":{"value":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"NEW","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"key":"outgoing","summary":"OUTGOING","id":"paths/~1account_transfers/post/responses/200/content/application~1json/examples/outgoing"},"paths/~1account_transfers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1account_transfers/post/responses/400/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_transfers/post/responses/401/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_transfers/post/responses/403/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_transfers/post/responses/404/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_transfers/post/responses/406/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_transfers/post/responses/429/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_transfers/post/responses/500/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_transfers/post/responses/503/content/application~1problem+json/example"},"paths/~1account_transfers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_transfers/post/responses/504/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming":{"value":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"SETTLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"key":"incoming","summary":"INCOMING","id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/incoming"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing":{"value":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"SETTLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"key":"outgoing","summary":"OUTGOING","id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/200/content/application~1json/examples/outgoing"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1account_transfers~1{account_transfer_id}/get/responses/504/content/application~1problem+json/example"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"NEW","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_new","summary":"INCOMING - NEW","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_new"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"PROCESSING","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"PROCESSING","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_processing","summary":"INCOMING - PROCESSING","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_processing"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"SETTLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_settled","summary":"INCOMING - SETTLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_settled"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"PARTIALLY_SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"CANCELLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_partially_settled","summary":"INCOMING - PARTIALLY_SETTLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_partially_settled"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"CANCELLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"CANCELLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"CANCELLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_cancelled","summary":"INCOMING - CANCELLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/incoming_cancelled"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"NEW","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_new","summary":"OUTGOING - NEW","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_new"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"PROCESSING","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"NEW","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"PROCESSING","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_processing","summary":"OUTGOING - PROCESSING","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_processing"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"SETTLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_settled","summary":"OUTGOING - SETTLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"PARTIALLY_SETTLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"SETTLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"CANCELLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_partially_settled","summary":"OUTGOING - PARTIALLY_SETTLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_partially_settled"},"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"ACCOUNT_TRANSFER.NEW","object":{"id":"63da4452-2dd3-4414-a7ca-66c0e3e89645","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"CANCELLED","transfer_type":"NO_OWNER_CHANGE","instruments":[{"id":"US0378331005","id_type":"ISIN","quantity":"10","status":"CANCELLED","transfer_id":"9637e68f-7065-4131-a072-6d57044ebd8c"},{"id":"US64110L1061","id_type":"ISIN","quantity":"5","status":"CANCELLED","transfer_id":"c2f84524-3f05-4849-909c-2998803327d3"}],"user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"ABCDDEFFXXX","account_number":"1234567891","name":"Max Mustermann"},"order_date":"2025-01-21"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_cancelled","summary":"OUTGOING - CANCELLED","id":"paths/Account Transfers events/post/requestBody/content/application~1json/examples/outgoing_cancelled"},"paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"created_at","order":"ASC"},"data":[{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},{"id":"64464124-18a2-4886-bc9f-c1b41fa8e4df","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"INCOMING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US88160R1014","instrument_id_type":"ISIN","quantity":"5","quantity_settled":"5","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"CEDELULLXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","actual_settlement_date":"2024-01-24","order_date":"2023-12-20","delay_reason":"COUNTERPARTY_NOT_RESPONDING"}]},"key":"incoming","summary":"INCOMING","id":"paths/~1securities_transfers/get/responses/200/content/application~1json/examples/incoming"},"paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing":{"value":{"meta":{"offset":0,"limit":100,"count":2,"total_count":2,"sort":"created_at","order":"ASC"},"data":[{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"OUTGOING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},{"id":"64464124-18a2-4886-bc9f-c1b41fa8e4df","created_at":"2025-01-22T14:10:00.00Z","updated_at":"2025-01-22T14:12:34.56Z","direction":"OUTGOING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US88160R1014","instrument_id_type":"ISIN","quantity":"5","quantity_settled":"5","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"CEDELULLXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","actual_settlement_date":"2024-01-24","order_date":"2023-12-20","delay_reason":"COUNTERPARTY_NOT_RESPONDING"}]},"key":"outgoing","summary":"OUTGOING","id":"paths/~1securities_transfers/get/responses/200/content/application~1json/examples/outgoing"},"paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1securities_transfers/get/responses/400/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1securities_transfers/get/responses/401/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1securities_transfers/get/responses/403/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1securities_transfers/get/responses/406/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1securities_transfers/get/responses/429/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1securities_transfers/get/responses/500/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1securities_transfers/get/responses/503/content/application~1problem+json/example"},"paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1securities_transfers/get/responses/504/content/application~1problem+json/example"},"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming":{"value":{"direction":"INCOMING","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","transfer_type":"NO_OWNER_CHANGE","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","order_date":"2024-01-20","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"}},"key":"incoming","summary":"INCOMING","id":"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming"},"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)":{"value":{"direction":"INCOMING","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","transfer_type":"NO_OWNER_CHANGE","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"key":"incoming (BYOL Omnibus)","summary":"INCOMING (BYOL Omnibus)","id":"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/incoming (BYOL Omnibus)"},"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing":{"value":{"direction":"OUTGOING","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","transfer_type":"NO_OWNER_CHANGE","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","order_date":"2024-01-20","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"}},"key":"outgoing","summary":"OUTGOING","id":"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing"},"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)":{"value":{"direction":"OUTGOING","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","transfer_type":"NO_OWNER_CHANGE","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"key":"outgoing (BYOL Omnibus)","summary":"OUTGOING (BYOL Omnibus)","id":"paths/~1securities_transfers/post/requestBody/content/application~1json/examples/outgoing (BYOL Omnibus)"},"paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming":{"value":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"key":"incoming","summary":"INCOMING","id":"paths/~1securities_transfers/post/responses/200/content/application~1json/examples/incoming"},"paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing":{"value":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"OUTGOING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"key":"outgoing","summary":"OUTGOING","id":"paths/~1securities_transfers/post/responses/200/content/application~1json/examples/outgoing"},"paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1securities_transfers/post/responses/400/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1securities_transfers/post/responses/401/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1securities_transfers/post/responses/403/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1securities_transfers/post/responses/404/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1securities_transfers/post/responses/406/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1securities_transfers/post/responses/429/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1securities_transfers/post/responses/500/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1securities_transfers/post/responses/503/content/application~1problem+json/example"},"paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1securities_transfers/post/responses/504/content/application~1problem+json/example"},"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"SECURITIES_TRANSFER.NEW","object":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_new","summary":"INCOMING - NEW","id":"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_new"},"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"SECURITIES_TRANSFER.SETTLED","object":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"INCOMING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"DAKVDEFFXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","actual_settlement_date":"2024-01-24","order_date":"2023-12-20","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"incoming_settled","summary":"INCOMING - SETTLED","id":"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/incoming_settled"},"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"SECURITIES_TRANSFER.NEW","object":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"OUTGOING","status":"NEW","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"CEDELULLXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","order_date":"2024-01-20"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_new","summary":"OUTGOING - NEW","id":"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_new"},"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled":{"value":{"id":"b5d0d9d0-bb8e-48b4-b2af-11df2b522353","created_at":"2024-01-22T14:10:00.00Z","type":"SECURITIES_TRANSFER.SETTLED","object":{"id":"9637e68f-7065-4131-a072-6d57044ebd8c","created_at":"2024-01-22T14:10:00.00Z","updated_at":"2024-01-22T14:12:34.56Z","direction":"OUTGOING","status":"SETTLED","transfer_type":"NO_OWNER_CHANGE","instrument_id":"US0378331005","instrument_id_type":"ISIN","quantity":"10","user_id":"7e9a0529-d289-4f4a-ae01-c2cd013d582e","account_id":"d396b7c3-aa67-488a-8e39-4a1a7cbeb9f4","settlement_reference":"b82dc5985558fdr2","counterparty":{"type":"BIC","id":"DUMBZZ33XXX","account_number":"1234567891","name":"Max Mustermann"},"settlement_counterparties":{"settlement_agent":{"identification":{"type":"BIC","value":"FAKEZZ55XXX"},"account":{"type":"SAFE","value":"DAKV1234"}},"settlement_party":{"identification":{"type":"BIC","value":"DUMBZZ33XXX"},"account":{"type":"SAFE","value":"1234567891"}}},"place_of_settlement":"CEDELULLXXX","trade_date":"2024-01-22","settlement_date":"2024-01-23","actual_settlement_date":"2024-01-24","order_date":"2023-12-20","delay_reason":"COUNTERPARTY_NOT_RESPONDING"},"webhook_id":"cab4673a-1381-4404-aec4-982dae33a38c"},"key":"outgoing_settled","summary":"OUTGOING - SETTLED","id":"paths/Securities Transfers events/post/requestBody/content/application~1json/examples/outgoing_settled"},"paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example":{"value":{"keys":[{"kid":"9ed77463-c18e-4794-ab5c-17423f9b801a","kty":"EC","crv":"P-521","x":"AcYAf5Ou0UvtehpeRvyhnvvrUQvjI4B3VCxfSmxK4gqKJGxO_jTB-nTdrHbBfmZpwmwYR86DppMg43E579K5MQ54","y":"ALkrId77iD0Ye2vBS5bTkLqPH-bo8urTpTXiNc6Ub-VOFbXfJrR0tQ8COvVXXu58BTu8jWV-1mtbjfJpDl3ISbcK"}]},"id":"paths/~1auth~1verify_keys/get/responses/200/content/application~1json/example"},"paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1auth~1verify_keys/get/responses/401/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1auth~1verify_keys/get/responses/403/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1auth~1verify_keys/get/responses/406/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1auth~1verify_keys/get/responses/429/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1auth~1verify_keys/get/responses/500/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1auth~1verify_keys/get/responses/503/content/application~1problem+json/example"},"paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1auth~1verify_keys/get/responses/504/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/200/content/application~1json/example":{"value":{"meta":{"offset":0,"limit":100,"count":1,"total_count":1,"sort":"id","order":"ASC"},"data":[{"id":"a8eb3540-5a84-40f9-b2bb-7f99f282fc5a","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","title":"User webhook","url":"https://tenant.tld/webhooks/users","type":["USER"],"enabled":false,"config":{"delay":"5s","max_package_size":10240}}]},"id":"paths/~1webhooks/get/responses/200/content/application~1json/example"},"paths/~1webhooks/get/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1webhooks/get/responses/400/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks/get/responses/401/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks/get/responses/403/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1webhooks/get/responses/406/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks/get/responses/429/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks/get/responses/500/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks/get/responses/503/content/application~1problem+json/example"},"paths/~1webhooks/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks/get/responses/504/content/application~1problem+json/example"},"paths/~1webhooks/post/requestBody/content/application~1json/example":{"value":{"title":"User webhook","url":"https://tenant.tld/webhooks/users","type":["USER"],"config":{"delay":"1s","max_package_size":51200}},"id":"paths/~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1webhooks/post/responses/201/content/application~1json/example":{"value":{"id":"a8eb3540-5a84-40f9-b2bb-7f99f282fc5a","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","title":"User webhook","url":"https://tenant.tld/webhooks/users","type":["USER"],"enabled":false,"config":{"delay":"5s","max_package_size":10240}},"id":"paths/~1webhooks/post/responses/201/content/application~1json/example"},"paths/~1webhooks/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1webhooks/post/responses/400/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks/post/responses/401/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks/post/responses/403/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1webhooks/post/responses/406/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks/post/responses/429/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks/post/responses/500/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks/post/responses/503/content/application~1problem+json/example"},"paths/~1webhooks/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks/post/responses/504/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example":{"value":{"id":"a8eb3540-5a84-40f9-b2bb-7f99f282fc5a","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","title":"User webhook","url":"https://tenant.tld/webhooks/users","type":["USER"],"enabled":true,"config":{"delay":"5s","max_package_size":1024}},"id":"paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/429/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/500/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/503/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks~1{webhook_id}/get/responses/504/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/401/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/403/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/429/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/503/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks~1{webhook_id}/delete/responses/504/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example":{"value":{"url":"https://tenant.tld/webhooks/users","type":["USER"]},"id":"paths/~1webhooks~1{webhook_id}/patch/requestBody/content/application~1json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example":{"value":{"id":"a8eb3540-5a84-40f9-b2bb-7f99f282fc5a","created_at":"2021-07-21T14:10:00.00Z","updated_at":"2021-07-21T14:10:00.00Z","title":"User webhook","url":"https://tenant.tld/webhooks/users","type":["USER"],"enabled":true,"config":{"delay":"1s","max_package_size":51200}},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/200/content/application~1json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/400/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/401/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/403/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/404/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/406/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/429/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/500/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/503/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks~1{webhook_id}/patch/responses/504/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example":{"value":{"url":"https://api.example.com/test","response":{"status":200,"headers":{"Content-Type":"application/json","X-Request-ID":"abc123"},"body":""}},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/200/content/application~1json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/401/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/403/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/404/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/406/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/429/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/500/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/503/content/application~1problem+json/example"},"paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1webhooks~1{webhook_id}~1test/post/responses/504/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example":{"value":{"account":{"iban":"NL70ABNA0106295004"},"amount":"13.37","currency":"EUR","client_reference":"client-reference","remittance_information":"remittance-info","purpose_code":"OTHR","counterparty_name":"counterparty-name","counterparty_account":{"iban":"DE95500105173934555844"},"counterparty_agent":{"bic":"DEUTDEFF"},"virtual_bank_account_id":"f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"},"id":"paths/~1tests~1payments~1transactions/post/requestBody/content/application~1json/example"},"paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example":{"value":{"id":"6ffa6b16-2380-4e7a-88b2-ae625c8eef99","bank_reference":"f2f0ef23-c68d-42c1-a744-8c86f471954b"},"id":"paths/~1tests~1payments~1transactions/post/responses/200/content/application~1json/example"},"paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example":{"value":{"status":400,"type":"bad_request"},"id":"paths/~1tests~1payments~1transactions/post/responses/400/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example":{"value":{"status":401,"type":"unauthorized"},"id":"paths/~1tests~1payments~1transactions/post/responses/401/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example":{"value":{"status":403,"type":"forbidden"},"id":"paths/~1tests~1payments~1transactions/post/responses/403/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example":{"value":{"status":404,"type":"not_found"},"id":"paths/~1tests~1payments~1transactions/post/responses/404/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example":{"value":{"status":406,"type":"not_acceptable"},"id":"paths/~1tests~1payments~1transactions/post/responses/406/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example":{"value":{"status":429,"type":"too_many_requests"},"id":"paths/~1tests~1payments~1transactions/post/responses/429/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example":{"value":{"status":500,"type":"internal_server_error"},"id":"paths/~1tests~1payments~1transactions/post/responses/500/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example":{"value":{"status":503,"type":"method_not_allowed"},"id":"paths/~1tests~1payments~1transactions/post/responses/503/content/application~1problem+json/example"},"paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example":{"value":{"status":504,"type":"gateway_timeout"},"id":"paths/~1tests~1payments~1transactions/post/responses/504/content/application~1problem+json/example"}},"securitySchemeStore":{"oauth-client-credentials":{"id":"oauth-client-credentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox.upvest.co/auth/token","scopes":{"accounts:read":"Read accounts and account groups","accounts:admin":"Create/update/delete accounts and account groups","webhooks:admin":"Create/update/delete webhooks","webhooks:read":"Read webhooks","files:read":"Read files metadata","orders:admin":"Create/update/delete orders","orders:read":"Read orders","users:admin":"Create/update/delete users","users:read":"Read users","checks:admin":"Create checks","checks:read":"Read checks","positions:read":"Read positions","positions_performance:read":"Read positions performance","reference_accounts:admin":"Create/update/delete reference accounts","reference_accounts:read":"Read reference accounts","mandates:admin":"Create/update/delete mandates","mandates:read":"Read mandates","payments:admin":"Payins and withdrawal operations","payments:read":"Payins and withdrawal read operations","topups:admin":"Top-ups operations","topups:read":"Top-ups read operations","cash_balance_transfers:admin":"Cash balance transfer operations","cash_balance_transfers:read":"Cash balance transfer read operations","credit_fundings:read":"Credit Fundings read operations","securities_transfers:read":"Securities Transfers read transfers","securities_transfers:admin":"Securities Transfers operations","isa_transfers:admin":"ISA Transfers operations","reports:read":"Read reports","reports:admin":"Create reports","taxes:read":"Read tax residencies","taxes:admin":"Modify tax residencies and tax exemptions","transactions:read":"Read cash and securities transactions","instruments:read":"Read instruments","fees:admin":"Create and read fee operations","fees:read":"Read fee operations","transaction_fees:admin":"Create and read transaction fee operations","transaction_fees:read":"Read transaction fee operations","portfolios:read":"Read portfolios","portfolios:admin":"Modify portfolios","valuations:read":"Read valuations","account_liquidations:read":"Read accounts liquidations","account_liquidations:admin":"Trigger/read/cancel accounts liquidations","account_returns:read":"Read accounts returns","virtual_cash_balances:admin":"Virtual cash balances","savings_plans:read":"Read savings plans","savings_plans:admin":"Create/read savings plans","prices:read":"Read instrument prices,","tests:admin":"Testing related operations","account_transfers:read":"Account Transfers read transfers","account_transfers:admin":"Account Transfers operations","businesses:admin":"Create/update/delete businesses,","businesses:read":"Read businesses,","roles:admin":"Create/update/deactivate roles","roles:read":"Read roles","corporate_actions:admin":"Create/update/delete corporate action instructions"}}}}},"servers":[{"url":"https://sandbox.upvest.co","description":"Sandbox environment"},{"url":"https://api.upvest.co","description":"Live environment"}]},"options":{"showExtensions":true,"hideInfoMetadata":true,"hidePropertiesPrefix":true,"hideSchemaTitles":true,"layout":"three-panel","sortRequiredPropsFirst":true,"hideReplay":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api.json?download"},{"url":"/_bundle/api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Upvest Investment API","description":"Upvest Investment API."}},"baseSlug":"/api","routesMapping":{}}