{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"093f3597-d86f-4e5b-9d4c-880fbfb644c0","name":"Compliance Module","description":"<b>Overview</b>\n\nThe most common use for the Compliance Module, is to help ensure that your customers are recommended Finance products that they are only Eligible / Recommended for, which allows your business to demonstrate you have sold products compliantly.\n\nIt is simply a knowledge based decision system, which you can use in whatever way you like. It simply provides the tools for you to utilise, to ensure compliance.\n\n<b>Prerequisites of using Compliance Module Endpoints</b>\n\nBefore you can make requests to a Compliance Module endpoint, you will need an API Key which you will send with every request (in the headers). Each endpoint will have an example request, showing you how this should be provided.\n\nIf you have not been provided with an API Key, please contact help@dealtrak.co.uk to have one set up.\n\n<b>Additional Guidance / FAQs</b>\n\nhttps://docs.dealtrak.co.uk/doku.php?id=fsuk:compliance:faqguidance\n\nIf you need an account to access the above Guidance / FAQs, please get in touch with DealTrak (help@dealtrak.co.uk) to be setup with an account.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6911751","team":300706,"collectionId":"093f3597-d86f-4e5b-9d4c-880fbfb644c0","publishedId":"S17jVrcb","public":true,"publicUrl":"https://docs.api.compliance.dealtrak123.co.uk","privateUrl":"https://go.postman.co/documentation/6911751-093f3597-d86f-4e5b-9d4c-880fbfb644c0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-04-17T10:41:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Compliance (External, LIVE)","id":"702db13e-e10c-416e-81b6-4edd480b2300","owner":"6911751","values":[{"key":"api-key","value":"X-API-KEY","enabled":true},{"key":"ar-answerableQuestionId","value":"{answerableQuestionId}","enabled":true},{"key":"ar-answerableQuestionSetId","value":"{answerableQuestionSetId}","enabled":true},{"key":"ar-aqsap-proofId","value":"{proofId}","enabled":true},{"key":"ar-aqsqa-submittedAnswerId","value":"{submittedAnswerId}","enabled":true},{"key":"ar-aqs-POST-questionSetType","value":"{questionSetTypeHandle}","enabled":true},{"key":"ar-aqs-POST-reference","value":"{reference}","enabled":true},{"key":"ar-aqs-GET-answerableQuestionSetReference","value":"{answerableQuestionSetReference}","enabled":true},{"key":"ar-aqs-GET-answerableQuestionSetReferences","value":"{answerableQuestionSetReferences}","enabled":true},{"key":"ar-aqsad-POST-deliverableId","value":"{deliverableId}","enabled":true},{"key":"ar-aqsad-POST-providedAt","value":"{providedAt}","enabled":true},{"key":"ar-aqsap-POST-documentName","value":"{documentName}","enabled":true},{"key":"ar-aqsap-POST-documentType","value":"{documentType}","enabled":true},{"key":"ar-aqsap-POST-proofId","value":"{proofId}","enabled":true},{"key":"ar-aqsap-POST-providedAt","value":"{providedAt}","enabled":true},{"key":"ar-aqsqa-POST-id","value":"{id}","enabled":true},{"key":"ar-aqsqa-POST-providedAt","value":"{providedAt}","enabled":true},{"key":"ar-aqsqa-POST-value","value":"{value}","enabled":true},{"key":"ar-products-POST-productId","value":"{productId}","enabled":true},{"key":"authenticatePassword","value":"{password}","enabled":true},{"key":"authenticateUsername","value":"{username}","enabled":true},{"key":"principalFirmId","value":"{principalFirmId}","enabled":true},{"key":"pf-appointedRepId","value":"{appointedRepresentativeId}","enabled":true},{"key":"pf-appointedRepGroupId","value":"{appointedRepresentativeGroupId}","enabled":true},{"key":"pf-deliverableId","value":"{deliverableId}","enabled":true},{"key":"pf-productId","value":"{productId}","enabled":true},{"key":"pf-profileId","value":"{profileId}","enabled":true},{"key":"pf-proofId","value":"{proofId}","enabled":true},{"key":"pf-questionId","value":"{questionId}","enabled":true},{"key":"pf-questionAnswerId","value":"{questionAnswerId}","enabled":true},{"key":"pf-questionSetId","value":"{questionSetId}","enabled":true},{"key":"pf-userId","value":"{userId}","enabled":true},{"key":"pf-POST-principalFirmName","value":"{principalFirmName}","enabled":true},{"key":"pf-ar-POST-appointedRepDocumentEmailText","value":"{appointedRepDocumentEmailText}","enabled":true},{"key":"pf-ar-POST-appointedRepName","value":"{appointedRepName}","enabled":true},{"key":"pf-arg-POST-appointedRepGroupFooterText","value":"{appointedRepGroupFooterText}","enabled":true},{"key":"pf-arg-POST-appointedRepGroupName","value":"{appointedRepGroupName}","enabled":true},{"key":"pf-arg-POST-documentName","value":"{documentName}","enabled":true},{"key":"pf-arg-POST-documentType","value":"{documentType}","enabled":true},{"key":"pf-del-POST-deliverableHandle","value":"{deliverableHandle}","enabled":true},{"key":"pf-del-POST-deliverableName","value":"{deliverableName}","enabled":true},{"key":"pf-del-POST-documentName","value":"{documentName}","enabled":true},{"key":"pf-del-POST-documentType","value":"{documentType}","enabled":true},{"key":"pf-matrix-POST-answerId","value":"{answerId}","enabled":true},{"key":"pf-matrix-POST-categoryId","value":"{categoryId}","enabled":true},{"key":"pf-matrix-POST-eligibilityId","value":"{eligibilityId}","enabled":true},{"key":"pf-matrix-POST-productTypeId","value":"{productTypeId}","enabled":true},{"key":"pf-prod-POST-boundType","value":"{boundType}","enabled":true},{"key":"pf-prod-POST-description","value":"{description}","enabled":true},{"key":"pf-prod-POST-liveDate","value":"{liveDate}","enabled":true},{"key":"pf-prod-POST-name","value":"{name}","enabled":true},{"key":"pf-profile-POST-profileName","value":"{profileName}","enabled":true},{"key":"pf-proof-POST-handle","value":"{handle}","enabled":true},{"key":"pf-proof-POST-name","value":"{name}","enabled":true},{"key":"pf-question-POST-parentQuestionId","value":"{parentQuestionId}","enabled":true},{"key":"pf-question-POST-tag","value":"{tag}","enabled":true},{"key":"pf-question-POST-text","value":"{text}","enabled":true},{"key":"pf-question-POST-type","value":"{type}","enabled":true},{"key":"pf-questionAnswer-POST-exitNode","value":"{exitNode}","enabled":true},{"key":"pf-questionAnswer-POST-sequence","value":"{sequence}","enabled":true},{"key":"pf-questionAnswer-POST-triggersChildren","value":"{triggersChildren}","enabled":true},{"key":"pf-questionAnswer-POST-value","value":"{value}","enabled":true},{"key":"pf-questionSet-POST-eligibilityStatement","value":"{eligibilityStatement}","enabled":true},{"key":"pf-questionSet-POST-liveAt","value":"{liveAt}","enabled":true},{"key":"pf-questionSet-POST-name","value":"{name}","enabled":true},{"key":"pf-questionSet-POST-sequence","value":"{sequence}","enabled":true},{"key":"pf-questionSet-POST-type","value":"{type}","enabled":true},{"key":"pf-user-POST-firstName","value":"{firstName}","enabled":true},{"key":"pf-user-POST-lastName","value":"{lastName}","enabled":true},{"key":"pf-user-POST-password","value":"{password}","enabled":true},{"key":"pf-user-POST-role","value":"ROLE_PRINCIPAL_FIRM_ADMIN","enabled":true},{"key":"pf-user-POST-state","value":"{state}","enabled":true},{"key":"pf-user-POST-username","value":"{username}","enabled":true},{"key":"productType-GET-productTypeId","value":"{productTypeId}","enabled":true},{"key":"productTypeCategory-GET-productTypeCategoryId","value":"{productTypeCategoryId}","enabled":true},{"key":"questionSetType-GET-questionSetTypeId","value":"{questionSetTypeId}","enabled":true},{"key":"questionTranslation-GET-questionSetId","value":"{questionSetId}","enabled":true},{"key":"questionType-GET-questionTypeId","value":"{questionTypeId}","enabled":true},{"key":"url","value":"https://api.compliance.dealtrak123.co.uk","enabled":true},{"key":"ar-products-POST-configSuspended","value":"{suspended}","enabled":true},{"key":"ar-products-POST-configUPB","value":"{upperPriceBound}","enabled":true},{"key":"ar-products-POST-configLPB","value":"{lowerPriceBound}","enabled":true},{"key":"ar-products-POST-configBoundType","value":"{boundType}","enabled":true},{"key":"ar-products-POST-configLiveDate","value":"{liveDate}","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/3877a5f1bf3210c22ad523563065f397dd383725b9979cb2476bef1a3a5db991","favicon":"https://dealtrak123.co.uk/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Compliance (External, LIVE)","value":"6911751-702db13e-e10c-416e-81b6-4edd480b2300"}],"canonicalUrl":"https://docs.api.compliance.dealtrak123.co.uk/view/metadata/S17jVrcb"}