--- title: "Create securities transfer" method: POST path: "/securities_transfers" tags: ["Securities Transfers"] --- # Create securities transfer `POST /securities_transfers` Create securities transfer ## Headers - `idempotency-key` string, uuid, required ## Request body - object - `direction` 'INCOMING' | 'OUTGOING', required — Direction of the securities transfer * `INCOMING` - Securities transfer is incoming to the user. * `OUTGOING` - Securities transfer is outgoing from the user. - `instrument_id` string, required — `ISIN` or other identity (depends on instrument_id_type) of the security to be transferred. - `instrument_id_type` 'ISIN', required — Type of the instrument_id * `ISIN` - International Securities Identification Number - `quantity` string, required — The quantity of instrument to move in or out. The value supported is maximum 15 digits including decimal place. *Note: For `INCOMING` 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.* - `transfer_type` 'NO_OWNER_CHANGE', required — Type of the securities transfer * NO_OWNER_CHANGE - No change of ownership. - `user_id` string, uuid, required — User unique identifier. - `account_id` string, uuid, required — Account unique identifier. - `place_of_settlement` string — Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362). - `settlement_reference` string, required — Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it. *NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!* *TIP: For non-live environment if you prefix the reference with `AUTO` your transfer gets through all lifecycle states.* - `counterparty` object, required — Counterparty with BIC (Bank Identifier Code) based identification for securities transfer. - `type` string, required — Type of the counterparty. - `id` string, required — Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362). - `account_number` string — 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. - `name` string — 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. - `settlement_counterparties` object — Settlement counterparties for the securities transfer. When `settlement_counterparties` is provided, `settlement_agent` is required. Other participants are optional but must respect the following dependency rules: * `settlement_custodian` presence requires `settlement_party` to be present. * `settlement_intermediary_1` presence requires `settlement_custodian` to be present. * `settlement_intermediary_2` presence requires `settlement_intermediary_1` to be present. Note: `settlement_custodian` can be provided without an explicit `settlement_party` since the default `counterparty` field at transfer level serves as the settlement party. - `settlement_agent` object, required — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_custodian` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_intermediary_1` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_intermediary_2` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_party` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `trade_date` string, date — 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. - `settlement_date` string, date — 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. - `order_date` string, date — Optional date when the transfer request was received from the end user. If omitted, Upvest defaults `order_date` to the transfer's `created_at` timestamp. The regulatory deadline runs from this date. Date in YYYY-MM-DD format. ## Response `200` Securities Transfer created - object - `id` string, uuid, required — Securities transfer request unique identifier. - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html) - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html) - `direction` 'INCOMING' | 'OUTGOING', required — Direction of the securities transfer * `INCOMING` - Securities transfer is incoming to the user. * `OUTGOING` - Securities transfer is outgoing from the user. - `status` 'NEW' | 'PROCESSING' | 'SETTLED' | 'CANCELLED', required — Status of the securities transfer * `NEW` - Securities transfer is created but not started processing. * `PROCESSING` - Securities transfer is in processing. * `SETTLED` - Securities transfer was successfully settled. * `CANCELLED` - Securities transfer was cancelled. - `transfer_type` 'NO_OWNER_CHANGE', required — Type of the securities transfer * `NO_OWNER_CHANGE` - No change of ownership. - `instrument_id` string, required — `ISIN` or other identity (depends on instrument_id_type) of the security to be transferred. - `instrument_id_type` 'ISIN', required — Type of the instrument_id * `ISIN` - International Securities Identification Number - `quantity` string, required — The quantity of instrument to move in or out. - `quantity_settled` string — The quantity of instruments settled. - `user_id` string, uuid, required — User unique identifier. - `account_id` string, uuid, required — Account unique identifier. - `place_of_settlement` string — Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362). - `settlement_reference` string, required — Unique identifier of the securities transfer set by API consumers. Useful for API consumers to build special logic on top of it. *NOTE: For automatic incoming transfers where API users will subscribe to the corresponding webhook, the value is set by Upvest!* - `counterparty` object, required — Counterparty with BIC (Bank Identifier Code) based identification for securities transfer. - `type` string, required — Type of the counterparty. - `id` string, required — Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362). - `account_number` string — 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. - `name` string — 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. - `settlement_counterparties` object — Settlement counterparties for the securities transfer. When `settlement_counterparties` is provided, `settlement_agent` is required. Other participants are optional but must respect the following dependency rules: * `settlement_custodian` presence requires `settlement_party` to be present. * `settlement_intermediary_1` presence requires `settlement_custodian` to be present. * `settlement_intermediary_2` presence requires `settlement_intermediary_1` to be present. Note: `settlement_custodian` can be provided without an explicit `settlement_party` since the default `counterparty` field at transfer level serves as the settlement party. - `settlement_agent` object, required — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_custodian` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_intermediary_1` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_intermediary_2` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `settlement_party` object — A participant in the settlement chain, identified by an identification and an optional account. - `identification` object, required — Identification of a settlement counterparty. * `BIC` Party identified by BIC. * `PROPRIETARY` Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` Party identified by name and address. - `type` 'BIC' | 'PROPRIETARY' | 'NAME_AND_ADDRESS', required — Type of identification. * `BIC` - Party identified by BIC. * `PROPRIETARY` - Party identified by a proprietary code under a Data Source Scheme. * `NAME_AND_ADDRESS` - Party identified by name and address. - `value` string, required — Identification value. The format depends on the `type`: * For `BIC`: A valid BIC code. * For `PROPRIETARY`: A proprietary identifier under the given `scheme`. * For `NAME_AND_ADDRESS`: Name and address of the party. - `scheme` string — ISO Data Source Scheme code. **Required** when `type` is `PROPRIETARY`. Identifies the source of the proprietary identification (e.g. `CRST`, `DAKV`, `CEDE`). - `account` object — Account of a settlement counterparty. * `SAFE` - Safekeeping account. - `type` 'SAFE', required — Type of the account. * `SAFE` - Safekeeping account. - `value` string, required — Account identifier value. - `trade_date` string, date, required — The forecast date when the trade takes place. Date in YYYY-MM-DD format. - `settlement_date` string, date, required — The forecast date when the settlement takes place. Date in YYYY-MM-DD format. - `actual_settlement_date` string, date — The date when the transfer settled, only known in `SETTLED` status. Date in YYYY-MM-DD format. - `order_date` string, date — 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` 'COUNTERPARTY_NOT_INSTRUCTING' | 'COUNTERPARTY_NOT_RESPONDING' | 'COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS' | 'COUNTERPARTY_NOT_ACCEPTING' — Categorised reason why a securities transfer is delayed past the regulatory deadline. * `COUNTERPARTY_NOT_INSTRUCTING` - The counterparty has not yet instructed the transfer. * `COUNTERPARTY_NOT_RESPONDING` - The counterparty is not responding. * `COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS` - The counterparty does not agree to the delivery details. * `COUNTERPARTY_NOT_ACCEPTING` - The counterparty is not accepting the transfer. ## Other responses - `400` — Bad Request. The incoming request had a malformed parameter/object. - `401` — Unauthorized. The caller has not been authenticated. - `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action. - `404` — Not Found. The requested resource could not be found. - `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value. - `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled. - `500` — Internal Server Error. The service encountered an unexpected error. - `503` — Service Unavailable. The service handling for this request cannot be reached at this time. - `504` — Gateway Timeout. The service gateway has reached its internal timeout. --- [API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/2c6bc192bc09/schema)