B3 Listed Markets (Listados) APIs

Post-trade APIs for the listed segment - iMercado investment fund registration and equities fee details, CORE risk calculation and simulation, unified client registration, asset lending, reconciliation files, and guarantee management report data.

OpenAPI Specification

b3-exchange-core-calculation-openapi.json Raw ↑
{"id":"87746959-3a37-40b6-af2b-0a8a9a167c73","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\r\n\r\nO objetivo dessa p\u00e1gina \u00e9 apresentar um conjunto de defini\u00e7\u00f5es de APIs (Application Programming Interfaces) desenvolvidas pela B3 que possibilitam realizar uma simula\u00e7\u00e3o de risco.\r\n\r\nO fluxo completo e detalhamento desta api est\u00e1 dispon\u00edvel no manual api simulador, dispon\u00edvel no site.\r\n\r\nEste documento descreve o conjunto de defini\u00e7\u00f5es da API desenvolvida pela B3 que ser\u00e3o utilizadas no processo de requisi\u00e7\u00e3o de simula\u00e7\u00e3o de risco.\r\n\r\nEsse documento trata especificamente da interface de comunica\u00e7\u00e3o API Web (REST) via internet.\r\n\r\nAs APIs (Application Programming Interface) WEB possibilitam aos participantes do servi\u00e7o pesquisar dados refer\u00eanciais, buscar portif\u00f3lios e requisitar simula\u00e7\u00e3o de risco.\r\n\r\nConstru\u00eddas no padr\u00e3o REST (Representational State Transfer), consistem em um conjunto de URL\u2019s (Uniform Resource Locator) que viabilizam a realiza\u00e7\u00e3o de coleta e envio de mensagens executadas por sistema.\r\n\r\nNa aba de m\u00e9todos est\u00e1 informada toda a documenta\u00e7\u00e3o necess\u00e1ria para as APIs (Application Programming Interfaces) ndfs, que possibilitam conex\u00f5es diretas entre os sistemas dos participantes e a plataforma do sistema CORE.\r\n\r\nA API ndfs utiliza verbos HTTPS (Hyper Text Transfer Protocol Secure) em uma arquitetura REST (Representational State Transfer), o que facilita a solicita\u00e7\u00e3o e o recebimento dos mesmos. A autentica\u00e7\u00e3o b\u00e1sica \u00e9 administrada por HTTPS e as respostas s\u00e3o entregues no formato JSON (Java Script Object Notation).\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\nA URL base para acesso aos endpoints deve ser conforme indicado abaixo:\r\n\r\n**Certifica\u00e7\u00e3o:**\r\nhttps:\/\/api-listados-cert.b3.com.br\r\n\r\n**Produ\u00e7\u00e3o:**\r\nhttps:\/\/api-listados.b3.com.br\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\r\n\r\n[Clique aqui](\/index.php?option=com_content&view=article&id=27) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado(Verificar, autentica\u00e7\u00e3o na pr\u00f3pria API).\r\n\r\n\r\n\r\n\r\n\r\n\r\n","deprecated":false,"apiVersion":"2.0.0-rc3","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/cors-app\/v2","models":{"Meta":{"type":"object","required":["totalPages","totalRecords"],"properties":{"totalRecords":{"type":"integer","format":"int32","example":2147483647,"description":"N\u00famero total de registros.","minimum":-2147483648,"maximum":2147483647},"totalPages":{"type":"integer","format":"int32","example":2147483647,"description":"N\u00famero total de p\u00e1ginas.","minimum":-2147483648,"maximum":2147483647}}},"Totalfcr":{"type":"object","properties":{"value":{"type":"number","format":"double","example":25668.55,"description":"Sum of positions  fcr"}}},"Optionbarrierlist":{"type":"object","properties":{"barrierType":{"type":"integer","format":"int16","example":1,"description":"Flexible option s barrier type. Domain: 0 - KNOCK_OUT_UP   1 - KNOCK_OUT_DOWN   2 - KNOCK_IN_UP   3 - KNOCK_IN_DOWN   4 - LIMIT","minimum":0,"maximum":100},"barrierValue":{"type":"number","format":"double","example":55.68,"description":"Flexible option s barrier value."}}},"Referencedata5":{"type":"object","properties":{"referenceDataToken":{"type":"string","example":"Ad54r6Hyyhh","description":"Reference data token","maxLength":40}}},"Referencedata":{"type":"object","properties":{"referenceDataToken":{"type":"string","example":"Ad54r6Hyyhh","description":"Reference data token","maxLength":40},"liquidityResourceLimitQuantity":{"type":"number","format":"double","example":3100000,"description":"Limit resource liquidity"},"securityGroups":{"type":"array","items":{"$ref":"#\/definitions\/Securitygrouplist"}}}},"Securitygroup":{"type":"object","properties":{"positionTypeId":{"type":"integer","format":"int16","example":0,"description":"Code that identifies the position type. Domain values: 0 - Position   1 - Collateral   2 - OTC","minimum":0,"maximum":100}}},"Risk":{"type":"object","properties":{"riskCalculationToken":{"type":"string","example":"Ad54r6Hyyhh","description":"Risk Calculation Token.","maxLength":250}}},"Swapleglist":{"type":"object","properties":{"currentValue":{"type":"number","format":"double","example":1000,"description":"swap leg s current value."},"legAdditiveSpreadValue":{"type":"number","format":"double","example":2.33,"description":"Swap leg s spread"},"legPercentage":{"type":"number","format":"double","example":35,"description":"Swap leg percentage indicator."},"otcIndicatorCode":{"type":"string","example":"PRE","description":"OTC s contract indicator code.","maxLength":50},"startPrice":{"type":"number","format":"double","example":22.54,"description":"swap leg initial price."},"swapLegType":{"type":"integer","format":"int16","example":1,"description":"Swap leg type 1 - ACTIVE   2 - PASSIVE","minimum":0,"maximum":100}}},"Security":{"type":"object","properties":{"symbol":{"type":"string","example":"PETR4","description":"An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise trade publicly. When a company issues securities to the public marketplace, it selects an available ticker symbol for its","maxLength":100}}},"LiquidityResource":{"type":"object","properties":{"value":{"type":"number","format":"double","example":25668.55,"description":"liquidity resource values to be applied on a simulation"}}},"FcrCalculationResult":{"type":"object","required":["status"],"properties":{"referenceDate":{"type":"string","example":"2018-08-31","description":"Specifies the calculation reference date. (Formato : YYYY-MM-DD)","maxLength":10},"totalFcr":{"$ref":"#\/definitions\/Totalfcr"},"status":{"$ref":"#\/definitions\/Status"},"positions":{"type":"array","items":{"$ref":"#\/definitions\/FcrPosition"}}}},"Otccontract":{"type":"object","properties":{"startPrice":{"type":"number","format":"double","example":100.63,"description":"OTC instrument initial price."},"notionalValue":{"type":"number","format":"double","example":9.99,"description":"OTC s contract notional value."},"underlyingSymbol":{"type":"string","example":"PETR4","description":"Symbol Code that identifies the underlying security.","maxLength":100},"contractCode":{"type":"string","example":"FCA","description":"Code that identifies the OTC Contract.","maxLength":50},"swapLegs":{"type":"array","items":{"$ref":"#\/definitions\/Swapleglist"}},"optionBarriers":{"type":"array","items":{"$ref":"#\/definitions\/Optionbarrierlist"}},"option":{"$ref":"#\/definitions\/Option"}}},"RiskAccountData":{"type":"object","properties":{"riskAccounts":{"type":"array","items":{"$ref":"#\/definitions\/Riskaccountlist"}}}},"RiskPositionList":{"type":"object","properties":{"security":{"$ref":"#\/definitions\/Security"},"securityGroup":{"$ref":"#\/definitions\/Securitygroup"},"collateral":{"$ref":"#\/definitions\/Collateral4"},"position":{"$ref":"#\/definitions\/Position3"},"otcContract":{"$ref":"#\/definitions\/Otccontract"},"securityLending":{"$ref":"#\/definitions\/Securitylending"}}},"FcrCalculationReq":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/FcrCalculationReqData"}},"id":"FcrCalculationReq"},"Status":{"type":"object","properties":{"requestStatus":{"type":"integer","format":"int16","example":0,"description":"Status da requisi\u00e7\u00e3o  Dominios:  0 - Sucesso 1 - Erro","minimum":0,"maximum":100},"messageStatus":{"type":"array","example":["erro 1"],"items":{"type":"string","example":"sint","description":"Mensagem referente ao status em caso de erro","maxLength":100}}}},"FcrPosition":{"type":"object","properties":{"positionTypeCode":{"type":"string","example":"P","description":"Code that identifies the position type. Domain values: 0 - Position   1 - Collateral   2 - OTC.","maxLength":3},"operationTypeCode":{"type":"string","example":"C","description":"Specifies the operation type of the position.","maxLength":3},"securityId":{"type":"string","example":"100001","description":"Specifies the instrument security id.","maxLength":100},"securityExchangeCode":{"type":"string","example":"BVMF","description":"Specifies the instrument security exchange.","maxLength":10},"securitySourceCode":{"type":"string","example":"8","description":"Specifies the instrument security source.","maxLength":3},"symbol":{"type":"string","example":"PETR4","description":"Specifies the instrument symbol.","maxLength":100},"assetCode":{"type":"string","example":"DOL","description":"Specifies the instrument asset.","maxLength":10},"positionQuantity":{"type":"number","format":"double","example":25668.55,"description":"Specifies the position s quantity"},"core0FlowValue":{"type":"number","format":"double","example":25668.55,"description":"Specifies the position s core 0 amount"},"mtmFlowValue":{"type":"number","format":"double","example":25668.55,"description":"Specifies the position s mtm amount"},"fcrValue":{"type":"number","format":"double","example":25668.55,"description":"Specifies the position s fcr amount"}}},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","example":"ratione","description":"C\u00f3digo do erro de neg\u00f3cio.","maxLength":10},"title":{"type":"string","example":"debitis","description":"Mensagem sucinta do erro de neg\u00f3cio.","maxLength":100},"detail":{"type":"string","example":"odit","description":"Informa\u00e7\u00f5es complementares a respeito do erro de neg\u00f3cio.","maxLength":2000}}},"RiskPortfolioData":{"type":"object","properties":{"calculationTimestamp":{"type":"string","format":"date-time","example":"2020-07-21T08:30:00Z","description":"time of the last risk calculation carried out for the portfolio (date and time) (Formato : YYYY-MM-DDTHH:MM:SSZ)"},"riskPortfolioToken":{"type":"string","example":"Ad54r6Hyyhh","description":"Risk portfolio Token.","maxLength":250},"riskPositions":{"type":"array","items":{"$ref":"#\/definitions\/RiskPositionList"}}}},"FcrCalculationResultRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/FcrCalculationResult"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"ReferenceDataRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/Referencedata"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"Securitylending":{"type":"object","properties":{"antecipatedPositionIndicator":{"type":"boolean","example":true,"description":"Indicates if the BTB s position can be antecipated"},"unlockDate":{"type":"string","example":"2017-02-05","description":"BTB contract unlock date (Formato : YYYY-MM-DD)","maxLength":10},"underlyingSymbol":{"type":"string","example":"PETR4","description":"Symbol Code that identifies the underlying security.","maxLength":100}}},"FcrCalculationRsp":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Risk"}}},"RiskAccountRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/RiskAccountData"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"Securitygrouplist":{"type":"object","properties":{"positionTypeId":{"type":"integer","format":"int16","example":0,"description":"Code that identifies the position type. Domain values: 0 - Position   1 - Collateral   2 - OTC","minimum":0,"maximum":100},"securityTypeCode":{"type":"integer","format":"int16","example":1,"description":"Code that identifies the security market classification in the trade process. Domain values: 0 - REGULAR   1 - EQUITY   2 - EQUITY_OPTION   3 - EQUITY_FORWARD   4 - COLLATERAL   5 - SECURITY_LENDING   6 - CENTRAL_BANK_AUCTION   7 - OTC_SWAP   8 - OTC_FLEXIBLE_OPTION   9 - OTC_NON_DELIVERABLE_FORWARD","minimum":0,"maximum":100},"symbols":{"type":"array","example":["PETR4"],"items":{"type":"string","example":"ducimus","description":"An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise trade publicly. When a company issues securities to the public marketplace, it selects an available ticker symbol for its.","maxLength":100}},"underlyingSymbols":{"type":"array","example":["PETR4"],"items":{"type":"string","example":"quasi","description":"Symbol Code that identifies the underlying security.","maxLength":50}},"otcContracts":{"type":"array","items":{"$ref":"#\/definitions\/Otccontractlist"}}}},"Position3":{"type":"object","properties":{"positionIdentification":{"type":"integer","format":"int32","example":123,"description":"The identification of the position is assigned and controlled by the user (broker).","minimum":0,"maximum":2147483647},"eligibleForCollateralIndicator":{"type":"boolean","example":true,"description":"Indicates whether the position is eligible for collateral"},"coveredQuantity":{"type":"number","format":"double","example":123.44,"description":"Position s covered quantity"},"tradeDate":{"type":"string","example":"2018-08-31","description":"Specifies the position trade date. (Formato : YYYY-MM-DD)","maxLength":10},"finalityCode":{"type":"integer","format":"int32","example":7788,"description":"Position finality indicator.","minimum":0,"maximum":2147483647},"longPrice":{"type":"number","format":"double","example":88.4577,"description":"Position s buy price."},"longQuantity":{"type":"number","format":"double","example":9.99,"description":"represents the buying quantity of a security"},"maturityDate":{"type":"string","example":"2025-08-30","description":"Maturity Date (Formato : YYYY-MM-DD)","maxLength":10},"shortPrice":{"type":"number","format":"double","example":9.99,"description":"Position s sell price"},"shortQuantity":{"type":"number","format":"double","example":855,"description":"represents the selling quantity of a security"},"sideIndicator":{"type":"boolean","example":true,"description":"Position side indicator.  true - BUY   false - SELL"},"startDate":{"type":"string","example":"2018-01-30","description":"Date the start (Formato : YYYY-MM-DD)","maxLength":10}}},"Position4":{"type":"object","properties":{"eligibleForCollateralIndicator":{"type":"boolean","example":true,"description":"Indicates whether the position is eligible for collateral"},"coveredQuantity":{"type":"number","format":"double","example":123.44,"description":"Position s covered quantity"},"tradeDate":{"type":"string","example":"2018-08-31","description":"Specifies the position trade date. (Formato : YYYY-MM-DD)","maxLength":10},"finalityCode":{"type":"integer","format":"int32","example":7788,"description":"Position finality indicator.","minimum":0,"maximum":2147483647},"longPrice":{"type":"number","format":"double","example":88.4577,"description":"Position s buy price."},"longQuantity":{"type":"number","format":"double","example":9.99,"description":"represents the buying quantity of a security"},"maturityDate":{"type":"string","example":"2025-08-30","description":"Maturity Date (Formato : YYYY-MM-DD)","maxLength":10},"shortPrice":{"type":"number","format":"double","example":9.99,"description":"Position s sell price"},"shortQuantity":{"type":"number","format":"double","example":855,"description":"represents the selling quantity of a security"},"sideIndicator":{"type":"boolean","example":true,"description":"Position side indicator.  true - BUY   false - SELL"},"startDate":{"type":"string","example":"2018-01-30","description":"Position s start date (Formato : YYYY-MM-DD)","maxLength":10}}},"Option":{"type":"object","properties":{"rebatePrice":{"type":"number","format":"double","example":101.88,"description":"Flexible option contract s rebate price."},"strikePrice":{"type":"number","format":"double","example":100,"description":"Flexible option contract s exercise price"}}},"Riskaccountlist":{"type":"object","properties":{"participantId":{"type":"string","example":"123456789012345","description":"Participant identification","maxLength":100},"accountId":{"type":"string","example":"111111124567897","description":"Account number","maxLength":100}}},"Otccontractlist":{"type":"object","properties":{"contractCode":{"type":"string","example":"SCP","description":"Code that identifies the OTC Contract.","maxLength":50},"otcIndicatorContractCodes":{"type":"array","example":["DOL"],"items":{"type":"string","example":"quis","description":"Indicator code of an OTC contract.","maxLength":50}}}},"Positionexclusionlist":{"type":"object","properties":{"positionIdentification":{"type":"integer","format":"int32","example":123,"description":"The identification of the position is assigned and controlled by the user (broker).","minimum":0,"maximum":2147483647}}},"Riskpositionlist2":{"type":"object","properties":{"securityGroup":{"$ref":"#\/definitions\/Securitygroup"},"security":{"$ref":"#\/definitions\/Security"},"collateral":{"$ref":"#\/definitions\/Collateral4"},"position":{"$ref":"#\/definitions\/Position4"},"otcContract":{"$ref":"#\/definitions\/Otccontract"},"securityLending":{"$ref":"#\/definitions\/Securitylending"}}},"errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}},"Link":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"deleniti","description":"Link para a p\u00e1gina atual.","maxLength":2000},"first":{"type":"string","example":"eius","description":"Link para a primeira p\u00e1gina.","maxLength":2000},"prev":{"type":"string","example":"ab","description":"Link para a p\u00e1gina anterior.","maxLength":2000},"next":{"type":"string","example":"nobis","description":"Link para a pr\u00f3xima p\u00e1gina.","maxLength":2000},"last":{"type":"string","example":"eligendi","description":"Link para a \u00faltima p\u00e1gina.","maxLength":2000}}},"Collateral4":{"type":"object","properties":{"positionQuantity":{"type":"number","format":"double","example":30,"description":"Position quantity"}}},"FcrCalculationReqData":{"type":"object","properties":{"referenceData":{"$ref":"#\/definitions\/Referencedata5"},"riskPortfolioToken":{"type":"string","example":"Ad54r6Hyyhh","description":"Risk portfolio Token.","maxLength":250},"liquidityResource":{"$ref":"#\/definitions\/LiquidityResource"},"riskPositions":{"type":"array","items":{"$ref":"#\/definitions\/Riskpositionlist2"}},"positionExclusions":{"type":"array","items":{"$ref":"#\/definitions\/Positionexclusionlist"}}}},"RiskPortfolioRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/RiskPortfolioData"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}}},"consumes":[],"produces":[],"authorizations":{"_default":{"scopes":[{"scope":"resource.WRITE"},{"scope":"resource.READ"}],"grantTypes":{"clientCredentials":{"url":"https:\/\/localhost:8089\/api\/oauth\/token","tokenName":"access_token"}},"type":"oauth2"}},"name":"API for CORE calculation","summary":"API for CORE calculation.","securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"basePaths":["https:\/\/developers.b3.com.br:8065"],"state":"published","cors":true,"expired":false,"retirementDate":0,"retired":false,"tags":{"Tipo":["PUBLICA"],"Grupo":["LISTADOS"]},"availableApiDefinitions":{"Swagger 1.1":"\/discovery\/swagger\/api\/id\/87746959-3a37-40b6-af2b-0a8a9a167c73?swaggerVersion=1.1&filename=API%2Bfor%2BCORE%2Bcalculation.json","Swagger 2.0":"\/discovery\/swagger\/api\/id\/87746959-3a37-40b6-af2b-0a8a9a167c73?swaggerVersion=2.0&filename=API%2Bfor%2BCORE%2Bcalculation.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/87746959-3a37-40b6-af2b-0a8a9a167c73\/ios-swift","android":"\/discovery\/sdk\/87746959-3a37-40b6-af2b-0a8a9a167c73\/android","nodejs":"\/discovery\/sdk\/87746959-3a37-40b6-af2b-0a8a9a167c73\/nodejs"},"apis":[{"path":"\/api\/cors-app\/v2\/risk-portfolio\/{participantId}\/{accountId}","name":"\/risk-portfolio\/{participantId}\/{accountId}","operations":[{"id":"f6da2929-ebb2-490f-944d-4c3cf0e6eb8b","description":"","httpMethod":"GET","nickname":"RiskPortfolioReqGet","summary":"Gets the account s portifolio","responseClass":"RiskPortfolioRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":406,"reason":"Not Acceptable"},{"code":410,"reason":"Gone"},{"code":415,"reason":"unsuported Media Type"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Participant identification","required":true,"maxLength":100,"name":"participantId","dataType":"string","paramType":"path","allowMultiple":false},{"description":"Account number","required":true,"maxLength":100,"name":"accountId","dataType":"string","paramType":"path","allowMultiple":false},{"description":"Indicates whether to copy the EoD portfolio.","required":false,"name":"isEod","dataType":"boolean","paramType":"query","allowMultiple":false},{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/cors-app\/v2\/fcr-calculation\/{calculationToken}","name":"\/fcr-calculation\/{calculationToken}","operations":[{"id":"1a7cf8fd-0ebb-462e-a70f-95aaf1260ebe","description":"","httpMethod":"GET","nickname":"FcrCalculationTtokenReqGet","summary":"Gets the fcr calculation result","responseClass":"FcrCalculationResultRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":406,"reason":"Not Acceptable"},{"code":410,"reason":"Gone"},{"code":415,"reason":"unsuported Media Type"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Calculation Token","required":true,"maxLength":250,"name":"calculationToken","dataType":"string","paramType":"path","allowMultiple":false},{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/cors-app\/v2\/risk-accounts","name":"\/risk-accounts","operations":[{"id":"313132b3-68d8-417d-bdc4-0c1fc3442645","description":"","httpMethod":"GET","nickname":"RiskAccountReqGet","summary":"Gets the list of accounts for calculation","responseClass":"RiskAccountRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":406,"reason":"Not Acceptable"},{"code":410,"reason":"Gone"},{"code":415,"reason":"unsuported Media Type"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/cors-app\/v2\/fcr-calculation","name":"\/fcr-calculation","operations":[{"id":"027918bc-66fa-4074-a806-efa12e3162d6","description":"","httpMethod":"POST","nickname":"FcrCalculationReqPost","summary":"Requests the fcr calculation (async)","responseClass":"FcrCalculationRsp","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":406,"reason":"Not Acceptable"},{"code":410,"reason":"Gone"},{"code":415,"reason":"unsuported Media Type"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"FcrCalculationReq","dataType":"FcrCalculationReq","paramType":"body","allowMultiple":false}]}]},{"path":"\/api\/cors-app\/v2\/reference-data","name":"\/reference-data","operations":[{"id":"8280cd2b-c837-4732-8f29-0b11ccfb00f5","description":"","httpMethod":"GET","nickname":"ReferenceDataReqGet","summary":"Gets the reference data","responseClass":"ReferenceDataRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":406,"reason":"Not Acceptable"},{"code":410,"reason":"Gone"},{"code":415,"reason":"unsuported Media Type"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]}],"createDate":1751308954576,"accessGrantedDate":1751308955840,"type":"rest","enableInlineTryIt":true}