BrokerageTemplate
Endpoints based around a brokerage template.
| API | Description |
|---|---|
| GET api/brokerageTemplate/{brokerageTemplateID} |
Get brokerage template data with brokerage template id |
| GET api/brokerageTemplate?id={id}&name={name}&extRef={extRef} |
Search brokerage template by criteria |
| POST api/brokerageTemplate |
Amend brokerage template data |
Invoices
Invoices API Controller
| API | Description |
|---|---|
| GET api/bfg/v1/invoices?ClientId={ClientId}&Filter={Filter}&PaymentStatus={PaymentStatus}&FromDate={FromDate}&ToDate={ToDate}&PageNumber={PageNumber}&PageSize={PageSize}&AfterId={AfterId}&SortBy={SortBy}&SortDirection={SortDirection} |
Lists posted service invoices for a client with optional filters and pagination (<c>SH_GetClientInvoices</c>). |
| GET api/bfg/v1/invoices/balance?clientId={clientId} |
Returns the Services account balance for a client (<c>SH_GetAccountsForObject</c>), used as the invoice balance. |
| GET api/bfg/v1/invoices/{transactionId}/{clientId}/pdf |
Get the PDF file of a invoices. |
Report
Report based endpoints.
| API | Description |
|---|---|
| GET api/report/getreports?reportTypes[0]={reportTypes[0]}&reportTypes[1]={reportTypes[1]}&startDate={startDate}&endDate={endDate} |
Get all reports by list of report types, startDate and endDate |
| GET api/report/{reportID} |
Get file by file ID. |
| POST api/report/orderReporting |
Generate Order Reporting report. |
| POST api/report/takeovers |
Generate Takeovers Reporting report. |
| POST api/report/principalCrossingReporting |
Generate Principal Crossing Reporting report. |
Accounts
| API | Description |
|---|---|
| GET api/bfg/v1/accounts?personID={personID}&status[0]={status[0]}&status[1]={status[1]} |
Get person's accounts |
| POST api/bfg/v1/accounts/{clientId}/mailing-address-chess-updates |
Start a CHESS-coupled client (domestic facility) mailing address change. Submits an MT203 registration details update with an Update Client Mailing Address task; the client's postal address is only applied — with client audit and diary — after ASX authorises via MT220. |
| GET api/bfg/v1/accounts/{clientId}/mailing-address-chess-updates/{taskId} |
Get the status of a CHESS-coupled client mailing address change task, for workflow polling. |
Orders
Ordering based endpoints.
| API | Description |
|---|---|
| POST api/orders |
Create a set of orders. |
| POST api/orders/order |
Create a single order. |
| POST api/orders/order/active |
Create a single active order. |
| POST api/orders/amendment |
Create a amendment instruction for an order. |
| POST api/orders/amendment/active |
Create an active amendment instruction for an order. |
| POST api/orders/amendments |
Create amendment instructions for multiple orders. |
| POST api/orders/cancellation |
Create a cancellation instruction for an order. |
| POST api/orders/cancellation/active |
Create a cancellation instruction for an order. |
| POST api/orders/cancellations |
Create cancellation instructions for multiple orders. |
| POST api/orders/approval |
Create approval instruction for an order. |
| POST api/orders/rejection |
Create rejection instruction for an order. |
| GET api/orders/v2?orderID[0]={orderID[0]}&orderID[1]={orderID[1]}&clientID={clientID}&status={status}&startDate={startDate}&endDate={endDate}&clientName={clientName}&clientExtRef={clientExtRef}&securityCodes[0]={securityCodes[0]}&securityCodes[1]={securityCodes[1]}&buySell={buySell}&nettingOrderIDs[0]={nettingOrderIDs[0]}&nettingOrderIDs[1]={nettingOrderIDs[1]} |
Get a list of orders details with wildcard support (*) for clientID, clientName and clientExternalRef parameter. e.g. Search client ID with value of 123, all clients with client ID contains of 123 will be returned. Version 2 will return less order information to the caller. |
| POST api/orders/valuation |
Gets the estimated order valuation |
| GET api/orders/{orderID}/value |
Get order values |
| GET api/orders/nettingorder/{nettingOrderID} |
Get netting order with netting order ID |
| POST api/orders/{nettingOrderID}/allocation/valuation |
Order Allocation Brokerage Valuation |
| POST api/orders/allocation |
Create a set of order allocations. |
| POST api/orders/ipo/block-allocations |
Create a set of order allocations. |
| POST api/orders/blockTrade/block-allocations |
Create a set of child Block Trade allocation(s) on existing Master/Parent Block Trade allocation. |
| POST api/orders/ipo/cancel-allocation |
Cancel IPO allocation |
| POST api/orders/blocktrade/cancel-allocation |
Cancel Master Block Trade allocation and it's child allocation(s). |
| GET api/orders/simpleorders?orderID[0]={orderID[0]}&orderID[1]={orderID[1]}&clientID={clientID}&status={status}&startDate={startDate}&endDate={endDate}&clientName={clientName}&clientExtRef={clientExtRef}&securityCodes[0]={securityCodes[0]}&securityCodes[1]={securityCodes[1]}&buySell={buySell}&nettingOrderIDs[0]={nettingOrderIDs[0]}&nettingOrderIDs[1]={nettingOrderIDs[1]} |
Get a list of orders basic details with wildcard support (*) for clientID, clientName and clientExternalRef parameter. e.g. Search client ID with value of 123, all clients with client ID contains of 123 will be returned. |
| POST api/orders/institutionalTrade/block-fee |
Publish Omgeo Create Block message |
| POST api/orders/blockTrade/block-fee |
Publish Omgeo Create Block message for block trades |
| POST api/orders/ipo/block-fee |
Publish Omgeo Create Block message for IPO/Placements |
| POST api/orders/institutionalTrade/block-allocations/v2 |
Create a task for child order client allocation(s) on existing Master allocation. |
| POST api/orders/allocation/cancellation/v2 |
Process Institutional block trade cancellation V2 from Omgeo |
ContractNotes
Contract Notes API Controller
| API | Description |
|---|---|
| GET api/bfg/v1/contract-notes/{contractNoteId}/pdf |
Get the PDF file of a contract note. |
| GET api/bfg/v1/contract-notes/{contractNoteId}/client |
Resolves the owning client for a contract note (<c>SH_GetContractNoteClientId</c>). |
| GET api/bfg/v1/contract-notes/netting-orders/{nettingOrderId}?sourceType={sourceType} |
Contract note totals for a netting order (<c>SH_GetContractNoteByNettingOrderID</c>). |
| GET api/bfg/v1/contract-notes/csv?ClientId={ClientId}&SecurityClassTypes={SecurityClassTypes}&BuySell={BuySell}&Filter={Filter}&FromDate={FromDate}&ToDate={ToDate}&SortBy={SortBy}&SortDirection={SortDirection} |
Download contract notes for a client as CSV, using the same filters as the contract-note enquiry (security class, side, text filter, date range, and sort). |
Watchlist
Endpoints based around a Watchlist object.
| API | Description |
|---|---|
| GET api/bfg/v1/watchlists?personID={personID} |
Get user-defined watchlists by person |
| GET api/bfg/v1/watchlists/items?personId={personId} |
Watch items for a person (<c>SH_GetWatchItemsByPersonID</c>). |
| GET api/bfg/v1/watchlists/{watchlistID}/watchlist-items |
No documentation available. |
Company
Endpoints based around a Company object.
| API | Description |
|---|---|
| GET api/company/{companyID} |
Gets company details based on the company ID |
| GET api/company?date={date}&externalRef={externalRef} |
Get all companies with matching date time created or updated, external reference |
| POST api/company |
Create new company |
| POST api/company/{companyID} |
Update a company |
| POST api/Company?companyID={companyID} |
No documentation available. |
Persons
| API | Description |
|---|---|
| POST api/bfg/v1/persons/validate-pin |
Validate a person's pin |
| GET api/bfg/v1/persons/{personId}/pin?brandId={brandId} |
Get the person's pin profile |
| POST api/bfg/v1/persons/activate-co-trading |
Activate conditional order trading for a person. PIN gate mirrors legacy <c>COTrading.aspx</c> / <c>LoginSession.PINOptOut</c>: opted out → skip PIN; otherwise PIN is required and validated via ValidatePINAndAttemptLimits. |
| GET api/bfg/v1/persons/{personId}/details |
Person contact and address details (<c>SH_GetPersonDetails</c>). |
| GET api/bfg/v1/persons/{personId}/services |
Services enabled for a person (<c>SH_GetPersonService</c>). |
| GET api/bfg/v1/persons/{personId}/co-trading-status |
Whether CO trading is active (<c>SH_IsCoTradingActive</c>). |
| POST api/bfg/v1/persons/{personId}/address |
Updates a person's residential or postal address in Paris. Calls <see cref="M:TPP.DataAccess.LLB.EntityClasses.PersonEntity.UpdateAddress(TPP.Utilities.enAddressType,TPP.DataAccess.LLB.DataClasses.AddressData,System.Int32)" /> directly to avoid changeAddress notification email. |
Funds
Funding API Controller
| API | Description |
|---|---|
| GET api/bfg/v1/funds?clientId={clientId} |
Get client available funds. |
| GET api/bfg/v1/funds/{clientId}/transactions?accountType={accountType}&filter={filter} |
Get the transaction statement for the particular client and account type. |
| GET api/bfg/v1/funds/{clientId}/transactions/csv?accountType={accountType}&filter={filter} |
Get the transaction statement for the particular client and account type and download in csv. |
| GET api/bfg/v1/funds/{clientId}/cash-accounts |
Gets the client's cash-related accounts (for example cash management and nominated bank accounts), including bank identifiers, masked account numbers where applicable, and balances when available. |
| GET api/bfg/v1/funds/cash-accounts?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]} |
Gets cash-related accounts for multiple Paris clients in one call. Each row includes <see cref="P:TPP.B2B.Webservices2.Contracts2.BFG.Funds.CashAccounts.ClientId" /> for upstream grouping. |
Platform
Endpoints based around Platform information.
| API | Description |
|---|---|
| GET api/platform/leverageequitiespid |
Get Leverage Equities PID in platform data |
| GET api/platform/GSTSchedule/{gSTScheduleRef} |
Get GST Schedule details for a given GST reference value. |
| GET api/platform/Countries |
Get List of Country |
Person
Endpoints based around a Person object.
| API | Description |
|---|---|
| GET api/person |
Get basic person details |
| GET api/person/{personID} |
Gets person details based on the person ID |
| GET api/person/persons?date={date}&externalRef={externalRef} |
Get all persons with matching date time created or updated, external reference, person ID Get persons details |
| GET api/person/externalreference/{reference} |
Get basic person details for a given external reference. |
| GET api/person/{personID}/clients |
Return a list of client accounts for the given person ID. |
| GET api/person/validateuniqueness?email={email}&mobile={mobile}&userName={userName}&brandID={brandID}&externalAdviserReference={externalAdviserReference} |
Validate person email, mobile or username uniqueness. |
| POST api/person |
Create new person account |
| POST api/person/advisor-person |
Create new advisor person |
| POST api/person/client-person |
Create new person account |
| POST api/person/client-person/{personID} |
Update a person account |
| GET api/person/watchscreens |
Get person watchscreens list |
| POST api/person/watchscreen |
Creates a watchscreen |
| POST api/person/watchscreen/{watchscreenID} |
Updates a watchscreen via the supplied ID in the URL |
| GET api/person/chartparameters |
Get person chart parameters |
| DELETE api/person/watchscreen/{watchscreenID} |
Delete an existing watchscreen |
| POST api/person/watchscreen/{watchscreenID}/securities |
Add securities to an existing watchscreen |
| DELETE api/person/watchscreen/{watchscreenID}/securities |
Remove securities from an existing watchscreen |
| GET api/person/recentquotes |
Gets a list of the most recently viewed security codes (up to a maximum of 5 codes) for the user. |
AccessRights
Endpoint to query group's access right
| API | Description |
|---|---|
| GET api/accessrights?groupID={groupID} |
Get the list of access rights for the authenticated user. |
| GET api/accessrights/groups/{groupID} |
Get the list of access rights for the authenticated user based on the groupID passed in. |
| POST api/accessrights/accessright |
Add a new access right based on data passed in |
| DELETE api/accessrights/accessright/{accessRightID} |
Delete an existing access right |
| GET api/accessrights/audit |
Get the audit records of access rights changes for Eclair Portal |
AdvisorTeam
Endpoints based around Advisor Teams management.
| API | Description |
|---|---|
| GET api/advisorteam/{advisorTeamID} |
Get advisor team |
| POST api/advisorteam |
Creates a new Advisor Team record |
Holdings
Holdings and holding entries for BFG (<c>SH_GetClientHoldings</c>, Paris_Info analytics).
| API | Description |
|---|---|
| GET api/bfg/v1/holdings |
Lists holdings for clients (<c>SH_GetClientHoldings</c>). |
| GET api/bfg/v1/holdings/holding-entries |
Lists holding entries (<c>SH_GetClientHoldingEntries</c>). |
| GET api/bfg/v1/holdings/top-stocks?personId={personId}&endDate={endDate} |
Top stocks held as-of end date (<c>SH_GetTopStockHeldByEndDate</c>). |
| GET api/bfg/v1/holdings/top-ten-last-value?securityCodes[0]={securityCodes[0]}&securityCodes[1]={securityCodes[1]}&endDate={endDate} |
Last values for security codes (<c>SH_GetTopTenStockLastValue</c>, Paris_Info). |
| GET api/bfg/v1/holdings/accumulated-vwap |
Accumulated VWAP for security codes (<c>SH_GetAccumulatedVWAP</c>, Paris_Info). |
| PATCH api/bfg/v1/holdings/{holdingID}/holding-entries/{holdingEntryID} |
Updates an existing holding entry's valuation. |
Order
| API | Description |
|---|---|
| GET api/bfg/v1/orders |
Lists client orders (<c>SH_GetClientOrders</c>). |
| GET api/bfg/v1/orders/top-trades?topType={topType}&personId={personId}&fromDate={fromDate}&toDate={toDate}&startDate={startDate}&endDate={endDate} |
Top buy/sell by date range (<c>SH_GetTopBuySellByDateRange</c>). |
| GET api/bfg/v1/orders/unsettled?ClientId={ClientId}&MinOutstandingClientObligationId={MinOutstandingClientObligationId}&PageNumber={PageNumber}&PageSize={PageSize}&SortBy={SortBy}&SortColumn={SortColumn}&SortDirection={SortDirection}&AfterId={AfterId}&Search={Search}&SearchKeyword={SearchKeyword}&FromDate={FromDate}&StartDate={StartDate}&ToDate={ToDate}&EndDate={EndDate} |
Unsettled orders for a client (<c>SH_GetPaginatedClientUnsettledOrders</c>). Resolves <see cref="P:TPP.B2B.Webservices2.Contracts2.BFG.Order.GetUnsettledOrdersRequest.MinOutstandingClientObligationId" /> when omitted or zero (no separate <c>GET unsettles</c> call required). |
| GET api/bfg/v1/orders/{orderId} |
Gets a single client order (<c>SH_GetClientOrderByOrderId</c>). |
| GET api/bfg/v1/orders/{orderID}/amendments |
Create an order amendment or cancellation for the specified order. |
| POST api/bfg/v1/orders/{orderID}/amendments |
No documentation available. |
| GET api/bfg/v1/orders/unsettles?clientId={clientId} |
[Deprecated] Outstanding fund obligations and min obligation id. Use <see cref="M:TPP.B2B.Webservices2.Controllers.APIControllers.BFG.OrderController.GetUnsettledOrders(TPP.B2B.Webservices2.Contracts2.BFG.Order.GetUnsettledOrdersRequest)" /> instead; min id is resolved server-side. |
| POST api/bfg/v1/orders/values |
Get calculated values for a batch of orders. |
| POST api/bfg/v1/orders/valuation |
Validates and valuates a batch of domestic orders for the supplied creator. each order is validated, then evaluated for risk/funds, and the valuation (brokerage, GST, fees, total) is calculated for orders that pass both stages. |
| POST api/bfg/v1/orders |
Creates a batch of domestic orders for the supplied creator. |
| POST api/bfg/v1/orders/amendments |
Cancelling multiple orders |
| GET api/bfg/v1/orders/{clientId}/histories/csv?securityClassTypes={securityClassTypes}&filterFromDate={filterFromDate}&filterToDate={filterToDate}&filterCode={filterCode}&filterType={filterType} |
Download order history into csv. |
Brand
Endpoints to support Brand level functions
| API | Description |
|---|---|
| GET api/brand/{brandID}/contracts?date={date}&pageNum={pageNum}&pageSize={pageSize} |
Get all contract notes generated on a specific day. Can be used to reconcile external systems. |
| GET api/brand/{brandID}/placementallocation-contractnotes?date={date} |
Get all placement allocation contract notes by brand for a specific date so that placement allocation contract notes able to reconcile for client accounts. |
| GET api/brand/{brandID}/outstanding-fundobligations |
Get all outstanding client fund obligations. This includes all fund obligations with status not set to 'complete' and/or 'AmountFunded' is less than 'Amount'. Can be used to reconcile external systems. |
| GET api/brand/{brandID}/holding-transactions?date={date} |
Get all holding transactions generated on a specific day. Can be used to reconcile external systems |
| GET api/brand/{brandID}/outstanding-stockobligations?pageNum={pageNum}&pageSize={pageSize} |
Get all outstanding stock obligations. This includes all stock obligations with status not set to 'complete' or 'QuantityFilled' is not equal to 'Quantity'. Can be used to reconcile external systems. |
| GET api/brand/{brandID}/holding-balances |
Get all non-zero holding balances. Can be used to reconcile external systems. |
| GET api/brand/{brandID}/open-orders |
Get all open orders. Can be used to reconcile external systems. |
Markets
Market information based endpoints.
ExternalTransaction
Endpoints based around External Transaction.
| API | Description |
|---|---|
| POST api/externaltransaction/cashMovements |
For external parties to call and provide instructions to move cash for an external product. |
| POST api/externaltransaction/cashMovements/multiple-transactions |
For external parties to call and provide instructions with multiple business transactions to move cash for an external product. Cash movement for Portfolio Service and Other Fees transaction type. |
AccessRightGroup
Endpoint to query access rights groups
| API | Description |
|---|---|
| GET api/accessrightgroups?authorityProviderID={authorityProviderID} |
Get the list of access right groups for the authenticated user. |
Account
Endpoints based around a client account.
ManagedFunds
ManagedFunds based endpoints.
| API | Description |
|---|---|
| POST api/ManagedFunds/Application |
Managed Fund Application Creation |
| POST api/ManagedFunds/Redemption |
Managed Fund Redemption Creation |
| POST api/ManagedFunds/Switch |
Managed Fund Switches Creation |
Market
Market information based endpoints.
| API | Description |
|---|---|
| GET api/market/securities/quotes/v2?codes[0]={codes[0]}&codes[1]={codes[1]} |
Gets quote information for a list of security codes |
| GET api/market/securities |
Get all securities details or security details for a given security code. |
| GET api/market/security/{code} |
Get security details for a given security code. |
| GET api/market/security/{code}/quote/v2?depthlines={depthlines} |
Get quote details for a given security code. For non-managed fund security code, this will also be added to recent codes. |
| GET api/market/security?search={search}&limit={limit} |
Get a list of securities based on user input. Minimum of 2 characters required before search is performed. |
| GET api/market/security/{code}/mfundpds |
Get the URI location and disclaimer for a MFunds PDS. |
| GET api/market/announcementtypes |
Gets all the announcement types and associated subtypes. These values are used as part of the search parameters in the announcements endpoint. |
| GET api/market/announcements?SecurityCodes[0]={SecurityCodes[0]}&SecurityCodes[1]={SecurityCodes[1]}&AnnouncementType={AnnouncementType}&AnnouncementSubType={AnnouncementSubType}&StartDate={StartDate}&EndDate={EndDate}&MarketSensitive={MarketSensitive}&Limit={Limit} |
Search for announcements |
| GET api/market/announcements/file/{fileid} |
Gets the announcement file |
| GET api/market/news/industrytypes |
Gets all news industry types. These values are used as part of the search parameters in the news endpoint. |
| GET api/market/news?SecurityCodes[0]={SecurityCodes[0]}&SecurityCodes[1]={SecurityCodes[1]}&IndustryCode={IndustryCode}&StartDate={StartDate}&EndDate={EndDate}&Limit={Limit} |
Search for news |
| GET api/market/news/{newsid} |
Gets the news article |
| GET api/market/security/{code}/recommendations |
Gets the research and recommendation information related to the security code |
| GET api/market/security/{code}/research |
Gets the research article details related to the security code |
| GET api/market/research/file/{fileid} |
Gets the research file |
| GET api/market/security/{code}/buysellSignals |
Gets the buysellSignals article details related to the security code |
| GET api/market/buysellSignals/file/{fileid} |
Gets the buysellSignals file |
| GET api/market/security/{code}/basisofquotation |
Get basis of quotation for a given security |
Trade
Trade based endpoints.
| API | Description |
|---|---|
| GET api/trades?tradeState={tradeState}&clientID={clientID}&clientExtRef={clientExtRef}&buySell={buySell}&securityCode={securityCode}&crossReference={crossReference}&brandIDs[0]={brandIDs[0]}&brandIDs[1]={brandIDs[1]}&tradeDate={tradeDate}&startTradeDate={startTradeDate}&endTradeDate={endTradeDate} |
Get a list of trades not yet fully allocated to contract notes. |
| POST api/trades/booking |
Unbook single or grouped trade lines with same security code. |
| POST api/trades/bookingTrades |
Unbook single or grouped trade lines with same security code. |
ConditionalOrders
API controller for managing conditional orders in the BFG system.
| API | Description |
|---|---|
| GET api/bfg/v1/conditional-orders?ClientId={ClientId}&Status={Status}&BuySell={BuySell}&PageNumber={PageNumber}&PageSize={PageSize}&SortBy={SortBy}&SortColumn={SortColumn}&SortDirection={SortDirection}&AfterId={AfterId}&Search={Search}&SearchKeyword={SearchKeyword}&FromDate={FromDate}&StartDate={StartDate}&ToDate={ToDate}&EndDate={EndDate} |
Lists conditional orders for a client (<c>SH_GetConditionalOrdersByClient</c>). |
| GET api/bfg/v1/conditional-orders/{conditionalOrderId} |
Gets a conditional order (<c>SH_GetConditionalOrderByID</c>). |
| PATCH api/bfg/v1/conditional-orders/{conditionalOrderId} |
Update conditional orders |
| POST api/bfg/v1/conditional-orders |
Create a conditional order. |
| POST api/bfg/v1/conditional-orders/valuations |
Previews validation and valuation for a conditional-order create or amendment without persisting it. |
| PATCH api/bfg/v1/conditional-orders |
Cancel all conditional orders |
International
International based endpoints.
| API | Description |
|---|---|
| POST api/international/orders/email |
Send international order email update |
| POST api/international/account/{accountUID} |
Update international account |
| POST api/international/v2/account/{accountUID} |
Update international account with Cognito authentication |
| POST api/international/person/{personUID} |
Update international user KYC status |
| POST api/international/instrument/remove-cache |
Reset international instrument cache by symbol key |
| GET api/international/forexrates |
Retrieve the Forex rates |
| POST api/international/fundtransfer/status |
Update international fund transfer status |
| POST api/international/holding-transfers/{internationalAccountHoldingMigrationEntryID}/status |
Update international holding transfer status |
UsernameRecovery
Bell Direct username recovery. Current client order is request, email verify, then OTP verify. Each action uses the global API throttle and requires the X-Correlation-ID header.
| API | Description |
|---|---|
| POST api/bfg/v1/persons/username-recovery/request |
Matches the person and sends the first email verification link. Every request with a valid mobile is counted for that brand and mobile before the person is matched, whether it matches or not. The attempt limit and lock window come from the brand profile UsernameRecoveryLockSettings (default LOCKED_HOURS=24;ATTEMPT=3). That many requests are allowed; the next one locks the mobile and its open person sessions for the lock window and returns 403 SESSION_LOCKED. A person who already completed recovery for the brand returns 403 REQUEST_NOT_ALLOWED. A locked person session returns 403 SESSION_LOCKED. An invalid mobile or other field error returns 400 FAILED and is not counted. |
| POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/otp/send |
Resends the SMS one-time password for a session on the OTP step. Issue cooldown and the issue limit return 400. A locked session returns 403 SESSION_LOCKED. |
| POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/otp/verify |
Checks the SMS one-time password and completes the recovery. Success is the hard block: a later request for that mobile returns 403 REQUEST_NOT_ALLOWED. A wrong or rejected code returns 400 with isSuccess false, an error code, and the current OTP detail. A locked session returns 403 SESSION_LOCKED. |
| POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/email/send |
Resends the email verification link for a session still on the email step. The current client flow does not call this. POST request sends the first email. The route stays available for a later resend. |
| POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/email/verify |
Checks the encrypted email-link code, moves the session to the OTP step, and sends the first SMS one-time password. An invalid or expired link returns 400. The attempt limit and a locked session return 403 SESSION_LOCKED. |