Transact is an award-winning UK based investment platform offering financial advisers and their clients smart technology.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8344085","collectionId":"609c505d-12e6-4fdd-83c2-5fd021a96fba","publishedId":"2sAYX9ogTh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-11T04:12:04.000Z"},"item":[{"name":"Overview","item":[{"name":"Authorisation Mechanism","item":[{"name":"OAuth 2.0 Authorisation Code Flow","item":[],"id":"53cbe029-e26b-4dd1-9db1-5de1bcf4a18c","description":"The OAuth 2.0 specification contains a collection of different flows. The specific flow Transact has implemented is called the OAuth 2.0 Authorisation Code Flow. This allows for an application to request permission from the TOL user to perform actions on their behalf. Official specifications can be found in the Appendix.
\nBelow is an explanation of the formal roles involved:
\n","_postman_id":"53cbe029-e26b-4dd1-9db1-5de1bcf4a18c"},{"name":"Glossary","item":[],"id":"c7024b8b-2015-43f7-b020-be00366f4cb5","description":"","_postman_id":"c7024b8b-2015-43f7-b020-be00366f4cb5"}],"id":"d73d9c94-0315-49a2-812a-bc37867262de","description":"Transact uses OAuth 2.0, an industry standard protocol that allows an end user to authorise an application to perform certain actions on behalf of the user, without the user's credentials being shared with the application itself.
\nIt allows software providers (you) to gain consent to perform actions (such as retrieval of data) on behalf of a Transact user. In the majority of cases this user will be an adviser firm. Transact Online (TOL) acts as an intermediary between the software provider's application and the Transact user, ensuring that the user's TOL credentials are kept secure and never sent to the software provider.
\n","_postman_id":"d73d9c94-0315-49a2-812a-bc37867262de"}],"id":"d4cbc1e5-7306-48e3-b545-51692aa3b540","description":"The Transact Data Services API provides a mechanism for your application to access data made available by the Transact platform.
\nThis documentation provides guidance for connecting with Transact's APIs.
\nYou will first need to contact Transact to have the User Acceptance Testing (UAT) environment enabled for you.
\nThe UAT environment will be available to you for two months. If more time is needed, you will need to contact Transact to extend access.
\nPlease note that data changes you make within the UAT environment are cleared every night, with the exception of OAuth and Allowed IP List settings that are cleared monthly as part of our regular release cycle. A 403 response may indicate that your OAuth Settings and Allowed IP List require reinstating.
\nOnce you are ready to connect to the production environment and request real client data, please refer to the Appendix > Production Environment Specifications section for further details.
\nFor assistance with Transact's Data Services API, please email the Transact Online team at tol@integrafin.co.uk.
\nImportant: The Transact services listed here are the ones that use OAuth for authorisation. If you would like to use Transact's Valuation or Transaction APIs, please get in touch with the Transact Online team for more information.
\n","_postman_id":"d4cbc1e5-7306-48e3-b545-51692aa3b540"},{"name":"Registration","item":[{"name":"Sign Up","item":[],"id":"f37a7a72-6ee8-46d0-8bc9-304f94f77f2b","description":"Please email the Transact Online team at tol@integrafin.co.uk to get your unique Client ID and your TOL software provider login credentials.
\n","_postman_id":"f37a7a72-6ee8-46d0-8bc9-304f94f77f2b"},{"name":"Managing Your Application's OAuth Settings","item":[],"id":"172b1c79-430c-41d2-959c-932b2450c310","description":"Manage your application's OAuth settings on TOL.
\nYou must generate a Client Secret and register your Redirect URI(s) here.
\nIf you use static URI parameters, include a ? followed by the parameters. This must exactly match the URI that you submit as part of the OAuth flow.
For example: https://example.com/callback?productid=334
Manage your allowed IP addresses on TOL.
\nYou must whitelist your relevant Client server IP addresses with Transact.
\n","_postman_id":"15619c2e-b137-4733-a3be-d0149c621ae0"}],"id":"8768ddca-9bab-4b6f-ae18-d75480b52953","_postman_id":"8768ddca-9bab-4b6f-ae18-d75480b52953","description":""},{"name":"Authorisation","item":[{"name":"Step 1: Redirect Users to Authorisation Endpoint","item":[{"name":"Authorisation Endpoint","id":"c616055a-601e-42b4-aada-f0e409e779d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.transact-online.co.uk/Oauth?client_id={{client_id}}&response_type=code&state={{state}}&scope={{oauth_scope}}&redirect_uri={{redirect_uri}}","urlObject":{"path":["Oauth"],"host":["https://demo.transact-online.co.uk"],"query":[{"description":{"content":"(Required) Your Client ID acquired as part of the registration process.
\n","type":"text/plain"},"key":"client_id","value":"{{client_id}}"},{"description":{"content":"(Required) Must always be code.
(Required) An opaque value generated by you to maintain a binding between the request and the User-Agent's authenticated state within your application. It must be a non-guessable value.
\n","type":"text/plain"},"key":"state","value":"{{state}}"},{"description":{"content":"(Required) The scope(s) being requested as part of the access request. For instance, you need to have the Read scope granted by the adviser firm in order to access Transact's Remuneration Statement API. Where there are multiple scopes, they should be delimited by a URL encoded space character %20.
(Required) This must match one of your pre-registered Redirect URIs.
\n","type":"text/plain"},"key":"redirect_uri","value":"{{redirect_uri}}"}],"variable":[]}},"response":[{"id":"0a7f6310-8156-4955-bc29-250e02796770","name":"Redirected to the Authorisation Endpoint Successfully","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.transact-online.co.uk/Oauth?client_id={{client_id}}&response_type=code&state={{state}}&scope={{oauth_scope}}&redirect_uri={{redirect_uri}}","host":["https://demo.transact-online.co.uk"],"path":["Oauth"],"query":[{"description":"(Required) Your Client ID acquired as part of the registration process.","key":"client_id","value":"{{client_id}}"},{"description":"(Required) Must always be `code`.","key":"response_type","value":"code"},{"description":"(Required) An opaque value generated by you to maintain a binding between the request and the User-Agent's authenticated state within your application. It must be a non-guessable value.\n","key":"state","value":"{{state}}"},{"description":"(Required) The scope(s) being requested as part of the access request. For instance, you need to have the `Read` scope granted by the adviser firm in order to access Transact's Remuneration Statement API. Where there are multiple scopes, they should be delimited by a URL encoded space character `%20`.\n","key":"scope","value":"{{oauth_scope}}"},{"description":"(Required) This must match one of your pre-registered Redirect URIs.","key":"redirect_uri","value":"{{redirect_uri}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c616055a-601e-42b4-aada-f0e409e779d5"}],"id":"5440dbb9-18d0-4a02-873b-bcc4f4e85f7d","description":"When the Resource Owner initiates the OAuth flow from within your application, the User-Agent must be redirected by the application to Transact's Authorisation Endpoint.
\n","_postman_id":"5440dbb9-18d0-4a02-873b-bcc4f4e85f7d"},{"name":"Step 2: Users Login and Grant Access","item":[],"id":"b865875d-23e0-4128-a600-78708f7eaf97","description":"Once a Resource Owner has been redirected to Transact's Authorisation Endpoint, they will be presented with the TOL login page.
\nImportant: Only adviser firm and adviser network Super Users are permitted by TOL to log in and grant your application access to Transact data. Additionally, in the production environment, this process requires that Super Users have Multi-Factor Authentication turned on.
\nOn login, the Resource Owner can be presented with the following on-screen error messages. These error messages are not returned to your application.
\nOnce the Resource Owner has logged in successfully without any of the above errors occurring, Transact will do further validation. If further errors occur, Transact will redirect the User-Agent back to your application via your Redirect URI. Below is the list of errors that can be included in the redirect.
\n","_postman_id":"b865875d-23e0-4128-a600-78708f7eaf97"},{"name":"Step 3: Transact Authorisation Server Redirects the Users Back to Your Application","item":[],"id":"6a2a2948-9b7b-434d-88da-17ef312774f4","description":"Once the user has granted access, Transact will redirect the User-Agent back to the provided Redirect URI. An Authorisation Code will be returned within the Redirect URI as parameter code. Your provided state value will also be included.
The redirect request will look like this:
\nGET https://example.com/callback?code=NewCode&state=YourStateValue
Important: To protect your application from Cross-Site Request Forgery (CSRF) attacks, we strongly suggest you check the validity of this request by verifying that the state value matches the User-Agent's authenticated state.
\n","_postman_id":"6a2a2948-9b7b-434d-88da-17ef312774f4"},{"name":"Step 4: Request a New Refresh and Access Token for the First Time","item":[{"name":"Token Exchange Endpoint","id":"f361c373-f8a5-4228-8ad9-1f8d25942602","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) Must be authorization_code.
(Required) The Authorisation Code supplied from the User-Agent.
\n","key":"code","value":"{{authorisation_code}}"},{"description":"(Required) Must match the Redirect URI used in the initial request to Transact's Authorisation Endpoint.
\n","key":"redirect_uri","value":"{{redirect_uri}}"}]},"url":"https://demo.transact-online.co.uk/Oauth/Token","description":"Authenticate with an Authorization header using Basic Authentication.
See the MDN for more information.
\n","urlObject":{"path":["Oauth","Token"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[]}},"response":[{"id":"37cd2b17-2e44-4520-98e2-aba34f75d202","name":"Acquired Refresh and Access Tokens Successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicOnce you have the Authorisation Code, it can be exchanged for a new Refresh Token and Access Token. The Authorisation Code is only valid for a short window of time, so it should be used as soon as possible. The Authorisation Code will be invalidated once used.
\nAs part of this step, the application is authenticated through submission of the Client ID and Client Secret. HTTP Basic Authentication is used. We only accept the application/x-www-form-urlencoded content type for the request.
If we receive a request with an incorrect Client Secret, the existing registered secret will be invalidated. You will need to log in and generate a new one (see the Registration > Managing Your Application's OAuth Settings section above).
\n","_postman_id":"bbc50b4b-fecc-4d85-9916-92efd947efa3"},{"name":"Step 5: Request a New Access Token","item":[{"name":"Refresh Access Token Endpoint","id":"c253b95b-b75c-4518-8cdc-47a0c86132cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Must be refresh_token.
The Refresh Token acquired by exchanging the Authorisation Code.
\n","key":"refresh_token","value":"{{refresh_token}}"}]},"url":"https://demo.transact-online.co.uk/Oauth/Token","description":"Authenticate with an Authorization header using Basic Authentication.
See the MDN for more information.
\n","urlObject":{"path":["Oauth","Token"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[]}},"response":[{"id":"9e0cf7a0-e8d7-4dab-a65c-941bbcca7736","name":"Acquired Access Token Successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicOnce an Access Token has expired, you will need to acquire a new Access Token by using a valid Refresh Token.
\nTo exchange the Refresh Token for a new Access Token, you will need to make a request to the same Token Endpoint.
\n","_postman_id":"d2e1af8a-7f4b-43c7-ae42-db715761c8c4"},{"name":"Token Revocation and Expiry","item":[],"id":"8a5b7833-8ad8-4904-bd1c-cc76b4918cae","description":"Please be aware that Transact provides users with the ability to revoke permissions granted to your application.
\nOnce the permissions are revoked or a Refresh Token has expired, the Client application will need to trigger the OAuth flow again.
\n","_postman_id":"8a5b7833-8ad8-4904-bd1c-cc76b4918cae"}],"id":"7125055c-ab14-4a2c-97a8-b812d7bc760f","description":"After registration, you can initiate the OAuth flow from within your application.
\nImportant: The example API calls provided list all possible responses and errors (see drop down box within each 'Example Request').
\n","_postman_id":"7125055c-ab14-4a2c-97a8-b812d7bc760f"},{"name":"APIs","item":[{"name":"Advisers API","item":[{"name":"Get a list of Advisers","id":"1ccfbd25-26c1-40ab-9d44-540037ad337f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Get a list of Advisers.
\n","urlObject":{"path":["trds","v1","advisers"],"host":["https://demo.transact-online.co.uk"],"query":[{"description":{"content":"The list of firm Transact numbers to filter on.
\n","type":"text/plain"},"key":"firm_ids","value":"123456789,987654321"}],"variable":[]}},"response":[{"id":"ddfce928-d426-4d0e-a5c1-b639941685d4","name":"Acquired Data Successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers?firm_ids=123456789,987654321","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers"],"query":[{"description":"The list of firm Transact numbers to filter on.","key":"firm_ids","value":"123456789,987654321"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"111111111\",\n \"surname\": \"Adviser\",\n \"given_names\": \"John\",\n \"fca_number\": \"ABC02345\",\n \"firm_id\": \"444444444\"\n },\n {\n \"id\": \"222222222\",\n \"surname\": \"Adviser\",\n \"given_names\": \"Ian\",\n \"fca_number\": \"ABC12345\",\n \"firm_id\": \"444444444\"\n },\n {\n \"id\": \"333333333\",\n \"surname\": \"Adviser\",\n \"given_names\": \"Pamela\",\n \"fca_number\": \"ABC22345\",\n \"firm_id\": \"555555555\"\n }\n]"}],"_postman_id":"1ccfbd25-26c1-40ab-9d44-540037ad337f"},{"name":"Get an Adviser","id":"a02720e1-6240-41b0-9d69-e6b09e008d60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Get an Adviser.
\n","urlObject":{"path":["trds","v1","advisers",":adviser_id"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[{"id":"1d8c8b22-286a-4584-bde0-842841955d78","description":{"content":"(Required) The adviser's Transact number.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"adviser_id"}]}},"response":[{"id":"0b27c44b-bf7e-4487-911f-ed042ef4fe59","name":"Acquired Data Successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id"],"variable":[{"key":"adviser_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"111111111\",\n \"surname\": \"Smith\",\n \"given_names\": \"John\",\n \"fca_number\": \"ABC12345\",\n \"firm_id\": \"222222222\"\n}"}],"_postman_id":"a02720e1-6240-41b0-9d69-e6b09e008d60"}],"id":"799e4211-68ed-4e32-9994-309217fce652","description":"The Advisers API provides information about advisers associated with the Resource Owner.
\nThe scope required to return an adviser/list of advisers is Read.
Returns an Adviser object.
\nAdviser:\n type: object\n required:\n - id\n - surname\n - given_names\n - fca_number\n - firm_id\n properties:\n id:\n allOf:\n - $ref: \"#/components/schemas/Id\"\n description: The adviser's Transact number.\n surname:\n type: string\n description: The surname of the adviser.\n example: \"Miggins\"\n given_names:\n type: string\n description: All given names of the adviser.\n example: \"John\"\n fca_number:\n type: string\n maxLength: 8\n description: The adviser's Identity Reference Number (IRN).\n example: \"ABC12345\"\n firm_id:\n allOf:\n - $ref: \"#/components/schemas/Id\"\n description: The firm's Transact number.\nId:\n type: string\n format: digit\n minLength: 9\n maxLength: 9\n example: \"123456789\"\nReturns a list of advisers. The list is sorted by surname then given_names, in ascending order.
Advisers:\n type: array\n uniqueItems: true\n description: The list of Advisers.\n items:\n $ref: \"#/components/schemas/Adviser\"\nRefer to \"Get an Adviser\" for the Adviser schema.
\n","_postman_id":"799e4211-68ed-4e32-9994-309217fce652"},{"name":"Firms API","item":[{"name":"Get a list of Firms","id":"cec54261-21cd-4476-b863-f042abc4ae36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Get a list of Firms.
\n","urlObject":{"path":["trds","v1","firms"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[]}},"response":[{"id":"1d26d076-f9f8-4dde-98c9-14de5f0561e5","name":"Acquired Data Successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://demo.transact-online.co.uk/trds/v1/firms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"111111111\",\n \"name\": \"Firm Company Ltd\",\n \"fca_number\": \"1234567\"\n },\n {\n \"id\": \"222222222\",\n \"name\": \"Adviser Company Ltd\",\n \"fca_number\": \"2234567\"\n },\n {\n \"id\": \"333333333\",\n \"name\": \"Adviser Firm Company Ltd\",\n \"fca_number\": \"3234567\"\n }\n]"}],"_postman_id":"cec54261-21cd-4476-b863-f042abc4ae36"},{"name":"Get a Firm","id":"267ce844-5e50-45bb-93c6-f6cdd8a6d9e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Get a Firm.
\n","urlObject":{"path":["trds","v1","firms",":firm_id"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[{"id":"1c0fb5c9-4e07-49ac-a310-7e73ce04e0c9","description":{"content":"(Required) The firm's Transact number.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"firm_id"}]}},"response":[{"id":"e2988308-7668-4f22-956f-42faa926d3da","name":"Acquired Data Successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/firms/:firm_id","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","firms",":firm_id"],"variable":[{"key":"firm_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"111111111\",\n \"name\": \"Firm Company Ltd\",\n \"fca_number\": \"1234567\"\n }\n]"}],"_postman_id":"267ce844-5e50-45bb-93c6-f6cdd8a6d9e1"}],"id":"5904b38b-6e47-4862-907b-358ecc3ebd8e","description":"The Firms API provides information about adviser firms associated with the Resource Owner.
\nThe scope required to return a firm/list of firms is Read.
Returns a Firm object.
\nIf the Resource Owner is an adviser firm, self can be used in place of the nine digit firm_id.
Firm:\n type: object\n required:\n - id\n - name\n - fca_number\n properties:\n id:\n allOf:\n - $ref: \"#/components/schemas/Id\"\n description: The firm's Transact number.\n name:\n type: string\n description: The name of the firm.\n example: \"Firm Company Ltd\"\n fca_number:\n type: string\n format: digit\n minLength: 6\n maxLength: 7\n description: The firm's Firm Reference Number (FRN).\n example: \"1234567\"\nId:\n type: string\n format: digit\n minLength: 9\n maxLength: 9\n example: \"123456789\"\nReturns a list of firms. The list of firms is sorted by name in ascending order.
Firms:\n type: array\n uniqueItems: true\n description: The list of Firms.\n items:\n $ref: \"#/components/schemas/Firm\"\nRefer to \"Get a Firm\" for the Firm schema.
\n","_postman_id":"5904b38b-6e47-4862-907b-358ecc3ebd8e"},{"name":"Account Opening API","item":[{"name":"Create and prepopulate Illustration and Guided Application","id":"731bf8af-573c-449f-af9e-f74bfb337073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Create a new illustration and prepopulate the illustration with information provided.
\n","urlObject":{"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"host":["https://demo.transact-online.co.uk"],"query":[],"variable":[{"id":"893ae2bb-4f07-4c83-9b67-494072cf7253","description":{"content":"(Required) The adviser's Transact number. The Advisers API provides values that are valid for the Resource Owner.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"adviser_id"}]}},"response":[{"id":"4d87a9d7-0176-4b4c-bf76-8507b26983c2","name":"Adult Portfolio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12345678\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"bank_account\": {\n \"sort_code\": \"123456\",\n \"account_number\": \"12345678\",\n \"account_name_or_roll_number\": \"Ian Miggins\",\n \"is_building_society\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"012345ab-cdef-ghij-klmn-opqrstuvwxyz\",\n \"adviser_id\": \"123456789\",\n \"name\": \"Ian Miggins created on 31/01/2024 00:00:00\",\n \"data\": {\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12345678\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"landline_number\": null,\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"care_of\": \"\",\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"registered_contact\": null,\n \"bank_account\": {\n \"sort_code\": \"123456\",\n \"account_number\": \"12345678\",\n \"account_name_or_roll_number\": \"Ian Miggins\",\n \"is_building_society\": false\n }\n },\n \"_links\": [\n {\n \"href\": \"https://demo.transact-online.co.uk/hub/prepop-apps/012345ab-cdef-ghij-klmn-opqrstuvwxyz\",\n \"rel\": \"html\",\n \"method\": \"GET\",\n \"description\": \"The URL to access the newly created illustration within Transact Online\"\n }\n ]\n}"},{"id":"eb822f09-6359-4573-8f1d-03325a098748","name":"Joint Portfolio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"123456782\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"landline_number\": {\n \"country\": \"GB\",\n \"number\": \"02079460000\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n },\n {\n \"title\": \"MRS\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Pamela\",\n \"previous_name\": \"Atkinson\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"FEMALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12354678\"\n }\n ],\n \"nino\": \"QQ123456C\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900001\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"bank_account\": {\n \"sort_code\": \"123456\",\n \"account_number\": \"12345678\",\n \"account_name_or_roll_number\": \"Ian Miggins\",\n \"is_building_society\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"234567abc-defg-hijk-lmno-pqrstuvwxyz\",\n \"adviser_id\": \"123456789\",\n \"name\": \"Ian Miggins and Pamela Miggins created on 31/01/2024 00:00:00\",\n \"data\": {\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12345678\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"landline_number\": null,\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"care_of\": \"\",\n \"address\": {\n \"line1\": \"1 Washington Street\",\n \"line2\": \"Worcester\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n },\n {\n \"title\": \"MRS\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Pamela\",\n \"previous_name\": \"Atkinson\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"FEMALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12354678\"\n }\n ],\n \"nino\": \"QQ123456C\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900001\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"registered_contact\": null,\n \"bank_account\": {\n \"sort_code\": \"123456\",\n \"account_number\": \"12345678\",\n \"account_name_or_roll_number\": \"Ian Miggins\",\n \"is_building_society\": false\n }\n },\n \"_links\": [\n {\n \"href\": \"https://demo.transact-online.co.uk/hub/prepop-apps/234567abc-defg-hijk-lmno-pqrstuvwxyz\",\n \"rel\": \"html\",\n \"method\": \"GET\",\n \"description\": \"The URL to access the newly created illustration within Transact Online\"\n }\n ]\n}"},{"id":"e70277d8-397d-48d6-98bf-455a8b87d037","name":"Child Portfolio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Jack\",\n \"date_of_birth\": \"2014-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n }\n ],\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"registered_contact\": {\n \"title\": \"MR\",\n \"surname\": \"Ian\",\n \"given_names\": \"Miggins\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12345678\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"456789abc-defg-hijk-lmno-pqrstuvwxyz\",\n \"adviser_id\": \"123456789\",\n \"name\": \"Jack Miggins created on 31/01/2024 00:00:00\",\n \"data\": {\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Jack\",\n \"date_of_birth\": \"2014-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n }\n ],\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"registered_contact\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Ian\",\n \"given_names\": \"Miggins\",\n \"date_of_birth\": \"1970-12-25\",\n \"country_of_birth\": \"GB\",\n \"gender\": \"MALE\",\n \"nationalities\": [\n \"GB\"\n ],\n \"tax_residencies\": [\n {\n \"country\": \"GB\"\n },\n {\n \"country\": \"AU\",\n \"tax_id\": \"12345678\"\n }\n ],\n \"nino\": \"QQ123456A\",\n \"investor_category\": \"RETAIL\",\n \"mobile_number\": {\n \"country\": \"GB\",\n \"number\": \"07700900000\"\n },\n \"email_address\": \"example@mail.com\",\n \"residential_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n },\n \"postal_address\": {\n \"address\": {\n \"line1\": \"49 Featherstone Street\",\n \"line2\": \"London\",\n \"post_code\": \"WR1 1NL\",\n \"country\": \"GB\"\n }\n }\n }\n ],\n \"bank_account\": null\n },\n \"_links\": [\n {\n \"href\": \"https://demo.transact-online.co.uk/hub/prepop-apps/456789abc-defg-hijk-lmno-pqrstuvwxyz\",\n \"rel\": \"html\",\n \"method\": \"GET\",\n \"description\": \"The URL to access the newly created illustration within Transact Online\"\n }\n ]\n}"},{"id":"25730825-d4c9-494a-811a-c70a3960eefa","name":"Illustration Limit Exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Illustration creation limit exceeded for adviser\"\n}"},{"id":"71bdc224-33ad-44a4-a8ac-93ac26ec92c2","name":"Invalid Date of Birth","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1895-12-31\"\n },\n {\n \"title\": \"MRS\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Pamela\",\n \"date_of_birth\": \"2500-02-28\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"The DoB must be between 1900-01-01 and present. Received: \\\"1895-12-31\\\", \\\"2500-02-28\\\"\"\n}"},{"id":"d1c41a83-f049-4dc9-8ceb-67ee275e3f6d","name":"Invalid Country","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"investors\": [\n {\n \"title\": \"MR\",\n \"surname\": \"Miggins\",\n \"given_names\": \"Ian\",\n \"date_of_birth\": \"1970-12-25\",\n \"nationalities\": [\n \"AA\",\n \"BB\",\n \"CC\",\n \"DD\"\n ]\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id/prepop-apps","host":["https://demo.transact-online.co.uk"],"path":["trds","v1","advisers",":adviser_id","prepop-apps"],"variable":[{"key":"adviser_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Invalid ISO 3166-1 alpha-2 country code. Received: \\\"AA\\\", \\\"BB\\\", \\\"CC\\\", \\\"DD\\\"\"\n}"}],"_postman_id":"731bf8af-573c-449f-af9e-f74bfb337073"}],"id":"3f3f125a-e518-4ee8-be37-0bfcd9ef0da2","description":"The Account Opening API is part of Transact's drive to make financial planning easier for UK\nfinancial advisers.
\nCurrently, there is a single endpoint to instruct creation of a Transact Personalised\nIllustration and to pre-populate certain data points within the Illustration and subsequent\nGuided Application.
\nThis helps to streamline the investor onboarding process by automatically filling in fields\nwith the information provided.
\nThis endpoint will accept either a single child applicant or up to two adult applicants.
\nTrust and Corporate applicants are currently out of scope.
\nOnce the Illustration is created, your software can take the user directly to their new\nIllustration within Transact-Online (TOL) to complete their Illustration and the\napplication process.
\nWhilst certain data points are optional, we encourage their use. Providing a complete set of\ndata points will minimise rekeying and save the adviser time.
\nThe scope required to create and prepopulate Illustrations and Guided Applications is Stage.
The table contains the supported request headers.
\nThe request body is a JSON structure that contains an IllustrationData object. See below\nfor details of this structure.
Below is the schema for the request body.
\nRequest:\n type: object\n description: >\n The request body which contains an IllustrationData object.\n allOf:\n - $ref: \"#/components/schemas/IllustrationData\"\nIllustrationData:\n type: object\n required:\n - investors\n properties:\n investors:\n type: array\n description: |\n The list of applicants.\n - If one adult individual is provided, an adult portfolio can be created.\n - If two adult individuals are provided, both a joint portfolio and individual\n portfolios can be created.\n - If one child individual is provided, a child portfolio will be created.\n items:\n $ref: \"#/components/schemas/Individual\"\n minItems: 1\n maxItems: 2\n registered_contact:\n type: object\n description: >\n Details of the Registered Contact. Only relevant for a child portfolio and is\n ignored where supplied for adult applicant(s).\n allOf:\n - $ref: \"#/components/schemas/Individual\"\n bank_account:\n $ref: \"#/components/schemas/BankAccount\"\nIndividual:\n type: object\n description: The individual details.\n required:\n - title\n - surname\n - given_names\n - date_of_birth\n properties:\n title:\n type: string\n description: The title of the individual.\n enum:\n - MR\n - MRS\n - MISS\n - MS\n - DOCTOR\n - PROFESSOR\n - THE_REVEREND\n - MASTER\n - LADY\n - SIR\n - MAJOR\n - CAPTAIN\n - LORD\n - LIEUTENANT_COLONEL\n - COMMANDER\n - COLONEL\n - THE_HONOURABLE\n - MAJOR_GENERAL\n - BRIGADIER\n - BARONESS\n - CANON\n - ALDERMAN\n - LIEUTENANT_COMMANDER\n - THE_RIGHT_HONOURABLE\n - THE_RIGHT_REVEREND\n - VISCOUNT\n - COUNTESS\n - PROFESSOR_SIR\n - SQUADRON_LEADER\n - THE_VERY_REVEREND\n - VISCOUNTESS\n - DAME\n - GENERAL\n - MARQUESS\n - SERGEANT\n - THE_VENERABLE\n - COUNT\n - FATHER\n - LIEUTENANT\n - REAR_ADMIRAL\n - RABBI\n - MX\n - COMMODORE\n - MARQUIS\n - ADMIRAL\n - VICE_ADMIRAL\n - SISTER\n surname:\n type: string\n description: The surname of the individual as it appears in passport.\n minLength: 1\n maxLength: 40\n example: \"Miggins\"\n given_names:\n type: string\n description: >\n All given names of the individual as they appear in passport including middle names.\n minLength: 1\n maxLength: 40\n example: \"Ian John\"\n previous_name:\n type: string\n description: The previous/maiden name of the individual.\n minLength: 1\n maxLength: 40\n example: \"Atkinson\"\n date_of_birth:\n type: string\n format: date\n description: >\n The date of birth of the individual. The date must be between 1900-01-01 and present,\n excluding any future dates.\n example: \"2025-06-30\"\n country_of_birth:\n type: string\n format: alpha\n description : The country must be a valid ISO 3166-1 alpha-2 country code.\n minLength: 2\n maxLength: 2\n example: \"GB\"\n gender:\n type: string\n description: The gender of the individual.\n enum:\n - MALE\n - FEMALE\n - UNDISCLOSED\n nationalities:\n type: array\n description: The nationalities of the individual.\n items:\n type: string\n format: alpha\n description: The country must be a valid ISO 3166-1 alpha-2 country code.\n minLength: 2\n maxLength: 2\n minItems: 0\n maxItems: 4\n uniqueItems: true\n tax_residencies:\n type: array\n description: The tax residencies of the individual.\n items:\n $ref: \"#/components/schemas/TaxResidency\"\n minItems: 0\n maxItems: 4\n uniqueItems: true\n nino:\n type: string\n description: >\n The National Insurance Number (NINO) of the individual. Ignored where supplied for a\n child applicant.\n minLength: 9\n maxLength: 9\n example: \"QQ123456C\"\n investor_category:\n type: string\n description: >\n The category of the investor. Ignored where supplied for a child applicant.\n enum:\n - RETAIL\n - PROFESSIONAL\n mobile_number:\n type: object\n description: >\n The mobile phone number of the individual. Ignored where supplied for a child applicant.\n allOf:\n - $ref: \"#/components/schemas/PhoneNumber\"\n landline_number:\n type: object\n description: >\n The landline phone number of the individual. Ignored where supplied for a child applicant.\n allOf:\n - $ref: \"#/components/schemas/PhoneNumber\"\n email_address:\n type: string\n format: email\n description: >\n The email address of the individual. Ignored where supplied for a child applicant.\n maxLength: 80\n residential_address:\n type: object\n description: The residential address of the individual.\n allOf:\n - $ref: \"#/components/schemas/ResidentialAddress\"\n postal_address:\n type: object\n description: >\n The postal address of the individual. Ignored where supplied for a child applicant.\n allOf:\n - $ref: \"#/components/schemas/PostalAddress\"\nBankAccount:\n type: object\n description: >\n The bank account information for the portfolio. Ignored where supplied for a child\n applicant.\n required:\n - sort_code\n - account_number\n - account_name_or_roll_number\n - is_building_society\n properties:\n sort_code:\n type: string\n format: digit\n description: The sort code of the bank account.\n minLength: 6\n maxLength: 6\n example: \"123456\"\n account_number:\n type: string\n format: digit\n description: The account number of the bank account.\n minLength: 8\n maxLength: 8\n example: \"12345678\"\n account_name_or_roll_number:\n type: string\n description: The bank account name or building society roll number.\n minLength: 1\n maxLength: 32\n example: \"Ian Miggins\"\n is_building_society:\n type: boolean\n description: >\n Boolean to specify whether the account represents a building society account.\nTaxResidency:\n type: object\n required:\n - country\n properties:\n country:\n type: string\n format: alpha\n description: The country must be a valid ISO 3166-1 alpha-2 country code.\n minLength: 2\n maxLength: 2\n example: \"GB\"\n tax_id:\n type: string\n description: >\n The tax identification number of the investor. Only relevant for a non GB country, tax\n identification will be ignore if provided for GB country.\n maxLength: 40\nPhoneNumber:\n type: object\n description: The phone number of the individual.\n required:\n - country\n - number\n properties:\n country:\n type: string\n format: alpha\n description: The country code must be a valid ISO 3166-1 alpha-2 country code.\n minLength: 2\n maxLength: 2\n example: \"GB\"\n number:\n type: string\n format: digit\n description: The phone number, excluding country prefix.\n minLength: 3\n maxLength: 20\n example: \"02079460000\"\nAddress:\n type: object\n required:\n - line1\n - line2\n - post_code\n - country\n properties:\n line1:\n type: string\n description: The first line of the address.\n minLength: 1\n maxLength: 60\n line2:\n type: string\n description: The second line of the address.\n minLength: 1\n maxLength: 60\n line3:\n type: string\n description: The third line of the address.\n maxLength: 60\n post_code:\n type: string\n description: The postcode of the address.\n minLength: 1\n maxLength: 10\n country:\n type: string\n format: alpha\n description: The country must be a valid ISO 3166-1 alpha-2 country code.\n minLength: 2\n maxLength: 2\nResidentialAddress:\n type: object\n required:\n - address\n properties:\n address:\n $ref: \"#/components/schemas/Address\"\nPostalAddress:\n type: object\n required:\n - address\n properties:\n address:\n $ref: \"#/components/schemas/Address\"\n care_of:\n type: string\n description: care of addressee name.\n maxLength: 40\nNOTE: The following properties are not used for a child (under age of 18 years old). These\n will be ignored if provided.
\nThe response is a Json structure that contains the illustration id, adviser_id, name, data and _links.
Response:\n type: object\n description: The response body which contains an Illustration object.\n required:\n - id\n - adviser_id\n - name\n - data\n - _links\n properties:\n id:\n type: string\n description: The id of the illustration created.\n _links:\n type: array\n uniqueItems: true\n description: The URIs relevant to the Account Opening API.\n items:\n $ref: \"#/components/schemas/Link\"\n adviser_id:\n allOf:\n - $ref: \"#/components/schemas/Id\"\n description: The adviser's Transact number.\n name:\n type: string\n description: >\n The illustration name consists of the investor names and date time of the illustration\n created.\n example: \"Ian Miggins created on 25/12/2024 00:00:00\"\n data:\n $ref: \"#/components/schemas/IllustrationData\"\nLink:\n type: object\n required:\n - href\n - rel\n - method\n - description\n properties:\n href:\n type: string\n description: The URL of the link.\n rel:\n type: string\n description: The relationship of the link to the resource.\n method:\n type: string\n description: The HTTP method that should be used for the link.\n description:\n type: string\n description: The description of the link.\nId:\n type: string\n format: digit\n minLength: 9\n maxLength: 9\n example: \"123456789\"\nOnce the illustration has been successfully created by calling the Prepopulate Illustration\nendpoint, the _links[0].href within the response body may be used to access the newly created\nillustration within TOL.
If the TOL user has since proceeded into Guided Applications, following this link will access\nthe associated application (with the option to return to the illustration).
\n","_postman_id":"3f3f125a-e518-4ee8-be37-0bfcd9ef0da2"},{"name":"Remuneration API","item":[{"name":"Get Latest Remuneration Statement","id":"d1448121-0a77-41ae-9ce9-c82b1c73a31c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Returns an array of statement objects representing all payments related to the most recent physical payment date. An empty array will be returned if there have been no physical bank payments for three months. For details related to the number of statements to expect, see the Remuneration API introduction above.
Returns an array of statement objects representing all physical bank payments made within a date range, up to three months in age. For details related to the number of statements to expect, see the Remuneration API introduction above.
(Required) The first statement date. The date format is YYYY-MM-DD. The start date must be within three months of today.
(Required) The last statement date. The date format is YYYY-MM-DD.
A payment Transact makes to a firm's (or network's) bank account represents an aggregation of\naccrued adviser fees. There is a standard payment for all firms that is paid on the 27th of each\nmonth. Firms can opt to receive two additional payments on the 7th and 17th. Bank holidays and\nweekends may cause variations to these dates. Offshore Bond related fees are paid separately.
\nThis means that in a given month, a firm may receive zero (if no payable fees were accumulated)\nto six payments. In rare circumstances, additional one-off payments can be made. Furthermore, a\nfirm can be part of an adviser network and have a period where some payments are paid to the\nfirm and some to the network. Details of all of these separate bank payments and associated\nadviser fees can be accessed by adviser firms and adviser networks under\nTOL > Reports > Payment Report, as an XLSX or CSV download.
\nThe Remuneration API provides this same remuneration data for each adviser\nwithin an adviser firm or network's business. More specifically, the API provides\nhierarchical data in the form of statements (that represent a single bank payment) and\ntransactions (client fees) associated with a statement.
\nNote that data accessible via this API is generated early in the morning and remains static\nthroughout the day. We recommend accessing this API after 6am GMT.
\nThe scope required to access remuneration statement data is Read.
The response is a JSON structure that contains an array of 'statement' objects, each\nrepresenting a physical bank payment made to a firm or network.
\nA statement object contains an array of transaction objects. A transaction is associated\nwith a single statement. A statement can be uniquely identified based on its payee, date and\noffshore/onshore status.
Note: There will often be a transaction object with no associated investor. Often this\nrelates to interest accrued on cash reserved for payment to the adviser firm or network,\nor more rarely, an adjustment made by Transact to an adviser's payment balance.
\nBelow is the schema for the response body.
\nRemRecStatementResponse:\n type: array\n items:\n type: object\n properties:\n payeeName:\n type: string\n description: The name of the payee.\n example: Adviser Firm\n payeeFca:\n type: string\n format: digit\n minLength: 1\n maxLength: 7\n description: The FCA number of the payee.\n example: \"1234567\"\n onshoreOffshore:\n type: string\n description: Whether the statement relates to onshore or offshore related remuneration.\n enum:\n - Onshore\n - Offshore\n example: Onshore\n statementDate:\n type: string\n description: Date of the statement. The date format is YYYY-MM-DD.\n format: date\n example: 2024-06-10\n statementTotal:\n type: number\n description: Total payment amount. Amount in pounds, to two decimal places.\n format: double\n example: 100.00\n transactions:\n type: array\n items:\n type: object\n properties:\n investorDetails:\n type: object\n description: This property will be null where there is no associated investor.\n properties:\n wrapperRef:\n type: string\n description: The unique reference used to identify a wrapper.\n pattern: ^IH\\d{8}$\n example: IH00000001\n portfolioName:\n type: string\n description: The name of the portfolio as presented on the Transact website.\n example: Doe, John\n portfolioNumber:\n type: string\n format: digit\n minLength: 9\n maxLength: 9\n description: The investor's unique Transact Number used to identify a portfolio.\n example: \"123456789\"\n wrapperType:\n type: string\n description: The type of the investor's wrapper.\n enum:\n - General Investment Account\n - ISA (Cash)\n - ISA (Stocks/Shares)\n - Junior ISA (Cash)\n - Junior ISA (Stocks/Shares)\n - Lifetime ISA\n - Personal Pension\n - SIPP\n - Section 32 Buy Out Bond\n - Executive Pension\n - Open Annuity\n - Offshore Bond\n - Onshore Bond\n paymentType:\n type: string\n description: Transaction category.\n enum:\n - Ongoing\n - Initial\n - Ad Hoc\n - Adviser Credit\n - Adjustment\n - Interest\n amount:\n type: number\n description: Transaction amount. Amount is in pounds and to two decimal places.\n format: double\n example: 100.00\n isVat:\n type: boolean\n description: True if the transaction represents a VAT adjustment related to a payment.\n transactionDate:\n type: string\n description: Date of the transaction. The date format is YYYY-MM-DD.\n format: date\n example: 2024-06-10\n adviserName:\n type: string\n description: Name of the adviser the transaction is associated with.\n example: Smith, John\n firmFca:\n type: string\n format: digit\n minLength: 1\n maxLength: 7\n description: FCA number of the adviser, adviser firm or adviser network the transaction is associated with.\n example: \"1234567\"\n firmName:\n type: string\n description: Name of the adviser firm the transaction is associated with.\n example: Adviser Firm\nBelow is the explanation of all the possible payment types.
\n","_postman_id":"108df851-b49c-4b96-a446-e0996b9a0ee5"},{"name":"Troubleshooting","item":[{"name":"400 Bad Request Error","item":[],"id":"94c6cc19-8037-4eb5-8b5d-c7f66d94b618","description":"Below are examples of some common invalid_request errors that you might encounter when accessing our APIs.
| Request Body | \nResponse Body | \nCause | \n
|---|---|---|
{\n \"title\": \"Mrs\",\n \"surname\": \"Miggins\",\n \"unknown_field\": \"value\"\n }\n | \n {\n \"error\": \"invalid_request\",\n \"error_description\": \"Unrecognised field: unknown_field\"\n }\n | \n The request body contains unrecognised fields. | \n
{\n \"title\": \"Mrs\",\n \"surname\": \"Miggins\",\n \"unknown_field\": \"value\"\n }\n | \n {\n \"error\": \"invalid_request\",\n \"error_description\": \"Unexpected value for field: title\"\n }\n | \n The request body contains an unrecognised value for a field. | \n
| Request URL | \nResponse Body | \nCause | \n
|---|---|---|
https://demo.transact-online.co.uk/trds/v1/advisers/abc123456/prepop-apps | \n {\n \"error\": \"invalid_request\",\n \"error_description\": \"adviser_id must have exactly 9 digit characters\"\n }\n | \n The provided adviser_id path parameter does not comply to our format. | \n
When your request to access our APIs...
\nAuthorization header valuesAuthorization header can be parsed... you will receive a 401 Unauthorized response.
The response may include some hints as to what might have gone wrong with your request in the WWW-Authenticate header.
When your request does not have permission to access the requested API, even though you have provided a valid access token, you will receive a 403 Forbidden response.
Depending on the cause of the issue, we might return a response with some hints as to what might have gone wrong in either the WWW-Authenticate response header or the response body.
| Response Body | \nCause | \n
|---|---|
{\n \"error\": \"unauthorised_client\",\n \"error_description\": \"Your IP address has not been whitelisted\"\n }\n | \n Your IP address has not been whitelisted. See the Registration -> Whitelist Your Servers section to whitelist your IP address. | \n
{\n \"error\": \"unauthorised_client\",\n \"error_description\": \"Valid Attestation missing\"\n }\n | \n The attestation is missing or lapsed and will need to be completed under TOL > Housekeeping > TRDS Terms of Business. | \n
{\n \"error\": \"invalid_grant\",\n \"error_description\": \"Invalid resource owner\"\n }\n | \n The resource owner has become inactive in our system. | \n
{\n \"error\": \"adviser_resource_access_denied\",\n \"error_description\": \"Insufficient permission to access the resource owned by the provided adviser_id.\"\n }\n | \n The Adviser is either inactive or not part of the adviser firm or network that owns the access token. | \n
When your request's Accept header contains only unaccepted response types, you will receive a 415 Unsupported Media Type response.
| Request Header | \nResponse Body | \n
|---|---|
Accept: application/pdf | \n {\n \"error\": \"unsupported_media_type\",\n \"error_description\": \"Invalid requested response type (Accept header): application/pdf. Expected one of: application/json\"\n }\n | \n
The APIs listed require a valid access token for authorisation purposes.
\nAll date/time values are represented in the ISO8601 format.
\nOptional fields must be omitted when there's no value provided.
\nNote: The provided example API calls list the most common responses. See the drop down box within each example.
\n","_postman_id":"6c1afdd2-5f70-4a36-af4d-25d79d2ce3ae"},{"name":"Try For Yourself","item":[{"name":"Advisers API","item":[{"name":"Get a list of Advisers","id":"bffcefb6-17bb-4666-a94f-3bdd6ab4632d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://demo.transact-online.co.uk/trds/v1/advisers?firm_ids=123456789,987654321","description":"Get a list of Advisers.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"The list of firm Transact numbers to filter on.
\n","type":"text/plain"},"key":"firm_ids","value":"123456789,987654321"}],"variable":[]}},"response":[],"_postman_id":"bffcefb6-17bb-4666-a94f-3bdd6ab4632d"},{"name":"Get an Adviser","id":"4d819adf-711f-499a-822a-7b57f1653466","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://demo.transact-online.co.uk/trds/v1/advisers/:adviser_id","description":"Get an Adviser.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"(Required) The adviser's Transact number.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"adviser_id"}]}},"response":[],"_postman_id":"4d819adf-711f-499a-822a-7b57f1653466"}],"id":"e5098c17-3d7b-4f08-95a3-eda881d8a149","_postman_id":"e5098c17-3d7b-4f08-95a3-eda881d8a149","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"Get a list of Firms.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"Get a Firm.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"(Required) The firm's Transact number.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"firm_id"}]}},"response":[],"_postman_id":"19b9283f-0526-43dd-9f91-f582be009e8d"}],"id":"16e865ea-97cc-4bcf-a233-0e4837959f48","_postman_id":"16e865ea-97cc-4bcf-a233-0e4837959f48","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"Create a new illustration and prepopulate the illustration with information provided.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"(Required) The adviser's Transact number. The Advisers API provides values that are valid for the Resource Owner.
\n","type":"text/plain"},"type":"any","value":"123456789","key":"adviser_id"}]}},"response":[],"_postman_id":"5d52c6a8-ebf4-4c4d-a58c-187cab3dbfe2"}],"id":"b3fab0a4-da27-405f-969e-135cacf034f2","_postman_id":"b3fab0a4-da27-405f-969e-135cacf034f2","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Read Stage"},{"key":"refreshRequestParams","value":"Returns an array of statement objects representing all payments related to the most recent physical payment date. An empty array will be returned if there have been no physical bank payments for three months. For details related to the number of statements to expect, see the Remuneration API introduction above.
Returns an array of statement objects representing all physical bank payments made within a date range, up to three months in age. For details related to the number of statements to expect, see the Remuneration API introduction above.
(Required) The first statement date. The date format is YYYY-MM-DD. The start date must be within three months of today.
(Required) The last statement date. The date format is YYYY-MM-DD.
You can import this documentation into Postman as a collection by clicking the Run in Postman button to try the Authorisation workflow and the APIs out for yourself.
\nBelow are the steps you need to take:
\nOAuth 2.0 RFC 6749 - Official documentation of the OAuth workflows
\nOAuth 2.0 RFC 6749, section 4.1 - OAuth2.0 Authorisation Code Flow
\n","_postman_id":"de1a9ab4-cd40-4594-ac16-fa050d6b9dab"},{"name":"UAT Environment Specifications","item":[],"id":"c6df9bb7-6367-466d-ae75-f9feb2d8d605","description":"Important: All changes made within the UAT environment are cleared every night. This includes:
\n