For AI agents: the docs index is at https://selfdecode.readme.io/v1.0.0/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
SelfDecode
API endpoints
Log InSelfDecode
API endpoints
Log In
API endpoints

Introduction

  • Authentication

Profile Service

  • Create a profile
  • Profile
    • /pro-signup-invite/post
    • /pro-signup-invite/{id}/del
    • /pro-signup-invite/{id}/accept/put
    • /profile/get
    • /profile/post
    • /profile/{id}/get
    • /profile/{id}/put
    • /profile/{id}/patch
    • /profile/{id}/del
    • /share-profile-request/get
    • /share-profile-request/post
    • /share-profile-request/{id}/get
    • /share-profile-request/{id}/put
    • /share-profile-request/{id}/patch
    • /share-profile-request/{id}/del
    • /share-profile-request/has-read/put
    • /shared-profile/get
    • /shared-profile/post
    • /shared-profile/{id}/get
    • /shared-profile/{id}/put
    • /shared-profile/{id}/patch
    • /shared-profile/{id}/del
    • /shared-profile/has-read/put
  • User
    • /total-profiles/get
  • Decody
    • /answer/post
    • /profile-questionnaire/get
    • /profile-questionnaire/post
    • /profile-questionnaire/{id}/get
    • /profile-questionnaire/{id}/available-questions/get
    • /profile-questionnaire/{id}/complete/put
    • /profile-questionnaire/{id}/questionnaire-info/get
    • /profile-questionnaire/{id}/send/put
    • /question/get
    • /question/{id}/get
    • /recommendations/get
  • Lifestyle Assessment
    • /lifestyle-assessment/get
    • /lifestyle-assessment-summary/get
    • /lifestyle-assessment-summary/{id}/get
    • /lifestyle-assessment/{id}/get
    • /profile-risk/get
    • /profile-risk/{id}/get
    • /profile-risk/{id}/put
    • /profile-risk/{id}/patch
    • /profile-suffering-risk/get
    • /profile-suffering-risk/post
    • /profile-suffering-risk/{id}/get
    • /profile-suffering-risk/{id}/put
    • /profile-suffering-risk/{id}/patch
  • Intake Form
    • /intake-form/get
    • /intake-form/post
    • /intake-form/{intakeform_id}/question/post
    • /intake-form/{intakeform_id}/question/{id}/put
    • /intake-form/{intakeform_id}/question/{id}/patch
    • /intake-form/{intakeform_id}/question/{id}/del
    • /intake-form/{intakeform_id}/question/{id}/delete-option/{option_id}/del
    • /intake-form/{id}/get
    • /intake-form/{id}/put
    • /intake-form/{id}/patch
    • /intake-form/{id}/reorder-questions/put
  • Lifestyle Analyzer API
    • Entities
    • Listing Assessments
    • Attempting an Assessment
    • Attempting an Assessment - Workflow Summary
    • Fetching Risk Score for Completed Assessment
    • Fetching Answers and their Impact on the Risk
    • Retaking an Assessment

Order Service

  • Order a DNA Kit flow
    • Sequence Diagram
  • DNAKitOrder
    • /order/get
    • /order/post
    • /order/{id}/get
    • /order/{id}/put
    • /order/{id}/patch
    • /order/{id}/del
  • DNASample
    • /product/dna-sample/get
    • /product/dna-sample/{sample_id}/get
    • /product/dna-sample/{sample_id}/put
    • /product/dna-sample/{sample_id}/file_upload/patch
  • DNAKitItem
    • /item/dna-kit-item/get
    • /item/dna-kit-item/{id}/get
  • Order a Lab Shop flow
    • Sequence Diagram for Home Kit Order
    • Sequence Diagram for Lab Panel / Test Order
  • LabTestOrder
    • /order/lab-shop-order/get
    • /order/lab-shop-order/post
    • /order/lab-shop-order/{id}/get
    • /order/lab-shop-order/{id}/put
    • /order/lab-shop-order/{id}/patch
    • /order/lab-shop-order/{id}/del
    • /vitamin-labs-order/get
    • /vitamin-labs-order/post
    • /vitamin-labs-order/{order_id}/put
    • /vitamin-labs-order/{order_id}/patch
  • LabTestItem
    • /category/get
    • /category/{id}/get
    • /collection-method/get
    • /collection-method/{id}/get
    • /item/lab-item/get
    • /item/lab-item/{id}/get
    • /item/lab-item/home-kit/get
    • /item/lab-item/home-kit/{id}/get
    • /item/lab-item/lab-panel/get
    • /item/lab-item/lab-panel/post
    • /item/lab-item/lab-panel/{id}/get
    • /item/lab-item/lab-panel/{id}/put
    • /item/lab-item/lab-panel/{id}/patch
    • /item/lab-item/lab-panel/{id}/del
    • /item/lab-item/lab-test/get
    • /item/lab-item/lab-test/{id}/get

Orders Service (v2)

  • DNASample
    • /product/dna-sample/get

Genome Files Service

  • Genome Files Service API
  • File
    • /service/genome-files/file/get
    • /service/genome-files/file/post
    • /service/genome-files/file-processing-service/version/get
    • /service/genome-files/file/{id}/get
    • /service/genome-files/file/{id}/put
    • /service/genome-files/file/{id}/patch
    • /service/genome-files/file/{id}/del
    • /service/genome-files/file/{id}/download/get
    • /service/genome-files/file/{id}/scan/post
    • /service/genome-files/file/{id}/selfdecode_path/get
    • /service/genome-files/file/download/profile/{profile_id}/get
    • /service/genome-files/file/full_genome_download/get
  • UploadURL
    • /service/genome-files/upload-url/post
    • /service/genome-files/upload-url/{id}/get
    • /service/genome-files/upload-url/{id}/del
  • ScanJob
    • /service/genome-files/scan-job/post
    • /service/genome-files/scan-job/detect_chip/post
  • UploadRawReads
    • /service/genome-files/upload-raw-reads/post
    • /service/genome-files/upload-raw-reads/{id}/get
    • /service/genome-files/upload-raw-reads/{id}/del
  • BulkUpload
    • /service/genome-files/bulk-upload/post
    • /service/genome-files/bulk-upload/{id}/get
    • /service/genome-files/bulk-upload/{id}/del

Reports Service

  • Reports Service API
  • Listing Reports
    • /service/reports/report/get
    • /service/reports/report-id/get
    • /service/reports/report-id/{id}/get
    • /service/reports/report-summary/get
    • /service/reports/report-summary/{id}/get
    • /service/reports/report/{id}/get
  • Composing Reports
    • /service/reports/profile-recommendation/get
    • /service/reports/profile-recommendation-trait/get
    • /service/reports/profile-recommendation-trait/{id}/get
    • /service/reports/profile-trait/get
    • /service/reports/profile-trait/{id}/get
    • /service/reports/recommendation-aggregate/get
  • Checking Report Status
    • /service/reports/profile-report/get
  • Generating Reports
    • /service/reports/profile-report/post
  • User Feedback
    • /service/reports/profile-recommendation/{id}/put
    • /service/reports/profile-report/{id}/put
    • /service/reports/profile-suffering-trait/get
    • /service/reports/profile-suffering-trait/post
    • /service/reports/profile-suffering-trait/{id}/get
    • /service/reports/profile-useful-recommendation/get
    • /service/reports/profile-useful-recommendation/post
    • /service/reports/profile-useful-recommendation/{id}/get
  • Internal
    • /service/reports/profile-recommendation/{id}/patch
    • /service/reports/profile-report/{id}/get
    • /service/reports/profile-report/{id}/patch
    • /service/reports/personalize-by-report/get
    • /service/reports/personalize-by-report/post
    • /service/reports/personalize-by-report/{id}/del
    • /service/reports/personalize-by-report/add-by-area/post
    • /service/reports/personalized-trait-text/get
    • /service/reports/personalized-trait-text/{id}/get
    • /service/reports/profile-last-viewed-new/get
    • /service/reports/profile-last-viewed-new/post
    • /service/reports/profile-last-viewed-new/{id}/get
    • /service/reports/profile-last-viewed-new/{id}/put
    • /service/reports/profile-last-viewed-new/{id}/patch
    • /service/reports/profile-last-viewed-new/{id}/del
    • /service/reports/profile-recommendation/reset-user-hidden/post
    • /service/reports/profile-report-summary/get
    • /service/reports/profile-report-summary/{id}/get
    • /service/reports/profile-report/generate-all/post
    • /service/reports/profile-report/has-generated/get
    • /service/reports/profile-status/get
    • /service/reports/profile-trait-condition/get
    • /service/reports/profile-trait-condition/{id}/get
    • /service/reports/recommendation/get
    • /service/reports/recommendation-trait/get
    • /service/reports/recommendation-trait/{id}/get
    • /service/reports/recommendation/{id}/get
    • /service/reports/trait/get
    • /service/reports/trait-summary/get
    • /service/reports/trait-summary/{id}/get
    • /service/reports/trait/{id}/get
    • /service/reports/user-favourited-report/get
    • /service/reports/user-favourited-report/post
    • /service/reports/user-favourited-report/{id}/get
    • /service/reports/user-favourited-report/{id}/del

PDF Generation Service

  • PDF generation - Special instructions
  • ReportPDFGeneration
    • /reports-pdf-report/get
    • /reports-pdf-report/post
    • /reports-pdf-report/v2/get
    • /reports-pdf-report/v2/post
  • ReportPDFGenerationPreference
    • /pdf-report-preference/get
    • /pdf-report-preference/post
    • /pdf-report-preference/{id}/get
    • /pdf-report-preference/{id}/put
    • /pdf-report-preference/{id}/patch
  • ComprehensiveReportPDFGeneration
    • /comprehensive-pdf-report/get
    • /comprehensive-pdf-report/post
  • ComprehensiveReportPDFGenerationPreference
    • /pdf-comprehensive-report-preference/get
    • /pdf-comprehensive-report-preference/post
    • /pdf-comprehensive-report-preference/{id}/get
    • /pdf-comprehensive-report-preference/{id}/put
    • /pdf-comprehensive-report-preference/{id}/patch
  • ComprehensiveReportCustomPage
    • /comprehensive-report-custom-page/get
    • /comprehensive-report-custom-page/post
    • /comprehensive-report-custom-page/{id}/get
    • /comprehensive-report-custom-page/{id}/put
    • /comprehensive-report-custom-page/{id}/patch
  • LabPDFGeneration
    • /labs-pdf-report/get
    • /labs-pdf-report/post
  • LabPDFGenerationPreference
    • /pdf-lab-preference/get
    • /pdf-lab-preference/post
    • /pdf-lab-preference/{id}/get
    • /pdf-lab-preference/{id}/put
    • /pdf-lab-preference/{id}/patch
  • Ancestry
    • /ancestry-custom-page/get
    • /ancestry-custom-page/post
    • /ancestry-custom-page/{id}/get
    • /ancestry-custom-page/{id}/put
    • /ancestry-custom-page/{id}/patch
    • /ancestry-pdf-preferences/get
    • /ancestry-pdf-preferences/post
    • /ancestry-pdf-preferences/{id}/get
    • /ancestry-pdf-preferences/{id}/put
    • /ancestry-pdf-preferences/{id}/patch
    • /ancestry-pdf-report/get
    • /ancestry-pdf-report/post
  • mtDNA
    • /mtdna-custom-page/get
    • /mtdna-custom-page/post
    • /mtdna-custom-page/{id}/get
    • /mtdna-custom-page/{id}/put
    • /mtdna-custom-page/{id}/patch
    • /mtdna-pdf-preferences/get
    • /mtdna-pdf-preferences/post
    • /mtdna-pdf-preferences/{id}/get
    • /mtdna-pdf-preferences/{id}/put
    • /mtdna-pdf-preferences/{id}/patch
    • /mtdna-pdf-report/get
    • /mtdna-pdf-report/post

ancestry Service

  • Ancestry Introduction
  • ancestry-summary
    • /ancestry-summary/get
    • /ancestry-summary/{id}/get
  • haplogroups
    • /haplogroups/get
    • /haplogroups/{id}/get
  • haplotype-summary
    • /haplotype-summary/get
    • /haplotype-summary/{id}/get
  • population-codes
    • /population-codes/get
    • /population-codes/{id}/get
  • start-ancestry-generation
    • /start-ancestry-generation/post

diets Service

  • Diets Service API
    • Get optimal diet and generate meal plan flow
    • Optimal Diet
    • Meal Detail
    • Profile Daily Meal Plan
    • Profile Grocery Item
  • Optimal Diet
    • /diet/get
  • Meal Detail
    • /meal/get
    • /meal/{id}/get
  • Profile Daily Meal Plan
    • /profile-daily-meal-plan/get
    • /profile-daily-meal-plan/post
    • /profile-daily-meal-plan/{id}/put
    • /profile-daily-meal-plan/{id}/patch
  • Profile Grocery Item
    • /profile-grocery-item/get

Lab Results Upload & Analysis

  • IMPORTANT: v2 API Docs
  • Lab Results Upload and Parsing
  • Lab Marker Analysis

Labs Service

  • discrete-range
    • /discrete-range/get
    • /discrete-range/{id}/get
  • discrete-result
    • /discrete-result/get
    • /discrete-result/post
    • /discrete-result/{id}/get
    • /discrete-result/{id}/put
    • /discrete-result/{id}/patch
    • /discrete-result/{id}/del
    • /discrete-result/bulk-delete/post
  • discrete-value
    • /discrete-value/get
    • /discrete-value/{id}/get
  • marker
    • /marker/get
    • /marker/{id}/get
  • marker-category
    • /marker-category/get
    • /marker-category/{id}/get
  • marker-condition
    • /marker-condition/get
    • /marker-condition/{id}/get
  • marker-gene
    • /marker-gene/get
    • /marker-gene/{id}/get
  • marker-group
    • /marker-group/get
  • marker-organ
    • /marker-organ/get
    • /marker-organ/{id}/get
  • marker-symptom
    • /marker-symptom/get
    • /marker-symptom/{id}/get
  • marker-unit
    • /marker-unit/get
  • numeric-range
    • /numeric-range/get
    • /numeric-range/{id}/get
  • numeric-result
    • /numeric-result/get
    • /numeric-result/post
    • /numeric-result/{id}/get
    • /numeric-result/{id}/put
    • /numeric-result/{id}/patch
    • /numeric-result/{id}/del
    • /numeric-result/bulk-delete/post
  • ocr
    • /ocr/get
    • /ocr/post
    • /ocr/get_presigned_url/get
  • ornament-webhook
    • /ornament-webhook/post
  • profile-health-score
    • /profile-health-score/get
  • profile-useful-recommendation
    • /profile-useful-recommendation/get
    • /profile-useful-recommendation/post
    • /profile-useful-recommendation/{id}/get
    • /profile-useful-recommendation/{id}/put
    • /profile-useful-recommendation/{id}/patch
  • queued-lab-shop-result
    • /queued-lab-shop-result/get
  • range-category
    • /range-category/get
    • /range-category/{id}/get
  • range-condition
    • /range-condition/get
    • /range-condition/{id}/get
  • recommendation
    • /recommendation/get
    • /recommendation/{id}/get
  • recommendation-aggregate
    • /recommendation-aggregate/get
  • report-lab-items
    • /report-lab-items/get
  • report-marker-info
    • /report-marker-info/get
  • result
    • /result/get
    • /result/{id}/get
    • /result/max-color/get
    • /result/profile-max-color/get
  • stats
    • /stats/result/get
  • unit
    • /unit/get
    • /unit/{id}/get
  • upload-request
    • /upload-request/get
    • /upload-request/post
    • /upload-request/{id}/get
    • /upload-request/get_presigned_post_url/get
    • Managing Other PDFs

B2B Integrations

  • IMPORTANT: v2 API Docs
  • Report Jobs
    • /report-job/get
    • /report-job/{id}/get
    • /report-job/profile/post
    • /report-job/profile/{profile_id}/post
    • /report-job/profile/{profile_id}/bulk-create/post
    • /report-job/profile/{profile_id}/generate-all/post
    • /report-job/profile/{profile_id}/report/{report_id}/get
    • /report-job/profile/bulk-create/post
    • /report-job/profile/generate-all/post
    • /report-job/upload-file/post
    • /report-summary/get
  • Building Report Detail Page
    • /composed-profile-report/{id}/get
    • /composed-profile-report/profile/{profile_id}/report/{report_id}/get
    • /profile-report-recommendation/get
    • /recommendation-id/get
    • /recommendation-summary/get
  • PDF Jobs
    • /pdf-job/get
    • /pdf-job/post
    • /pdf-job/{id}/get
  • Managing Reports + PDFs
  • Managing Other PDFs
  • PDF Configurations
    • Report PDF Config
    • Lab PDF Configs
  • Labs
    • /marker-summary/get
  • Webhooks
    • /user-webhook/get
    • /user-webhook/post
    • /user-webhook/{id}/get
    • /user-webhook/{id}/put
    • /user-webhook/{id}/patch
    • /user-webhook/{id}/del
    • /user-webhook/{id}/recover/put
    • /user-webhook/{id}/reset-secret/put
Powered by 

Sequence Diagram for Home Kit Order

Updated about 3 years ago


What’s Next

  • Sequence Diagram for Lab Panel / Test Order
Did this page help you?

Updated about 3 years ago


What’s Next

  • Sequence Diagram for Lab Panel / Test Order
Did this page help you?