// Recipes gallery + recipe modal — replicates the ReadMe developer hub recipes experience. (function () { var RECIPES = [{"title":"Create a Deal","description":"Submit a loan tape as an originator \u2014 initiate the upload, push your file, and mark the deal for review.","icon":"file-text","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Initiate the Deal","request":"curl -X POST https://api.9squid.com/v1/api/originator/loans \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"type\": \"Auto\" }'","response":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-abc123.upload\",\n \"expires_in\": 3600\n }\n}","content":[{"md":"

Call POST /originator/loans with your loan type. The platform creates a new deal in DRAFT status and returns an upload URL valid for 1 hour.

Supported loan types: Auto, Personal, Mortgage, Student, Business, Credit Card

If a DRAFT deal already exists for the same loan type, it will be reused and a fresh URL returned.

"},{"title":"Step 1 \u2014 Initiate the Deal","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/loans \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"type\": \"Auto\" }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-abc123.upload\",\n \"expires_in\": 3600\n }\n}"}]},{"title":"Step 2 \u2014 Upload the File","request":"curl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @your-loan-tape.csv","response":"{\n \"success\": true,\n \"file_path\": \"upload/documents/deals/clx1a2b3c4d5e6f7g8h9/loan-tape-abc123.upload\"\n}","content":[{"md":"

Use the upload_url from Step 1 to push your CSV or XLSX file. The URL routes through the platform gateway \u2014 include your Authorization header as with any other request.

"},{"title":"Step 2 \u2014 Upload the File","lang":"bash","code":"curl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @your-loan-tape.csv"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"file_path\": \"upload/documents/deals/clx1a2b3c4d5e6f7g8h9/loan-tape-abc123.upload\"\n}"},{"md":"

The upload URL expires in 1 hour. If it expires, call PATCH /originator/loans/:dealId to get a fresh one.
Content-Length is required \u2014 S3 needs it to accept the stream.

"}]},{"title":"Step 3 \u2014 Complete the Upload","request":"curl -X POST https://api.9squid.com/v1/api/originator/loans/complete \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"file_name\": \"loan-tape-abc123.upload\"\n }'","response":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"deal_status\": \"IN_REVIEW\"\n }\n}","content":[{"md":"

Notify the platform that the file is ready. The gateway verifies the file, registers it, and transitions the deal to IN_REVIEW.

"},{"title":"Step 3 \u2014 Complete the Upload","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/loans/complete \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"file_name\": \"loan-tape-abc123.upload\"\n }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"deal_status\": \"IN_REVIEW\"\n }\n}"}]},{"title":"Step 4 \u2014 Check Deal Status","request":"curl https://api.9squid.com/v1/api/originator/loans/clx1a2b3c4d5e6f7g8h9 \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"status\": \"QC_COMPLETED\"\n }\n}","content":[{"md":"

Poll the deal to track its progress through the review pipeline.

"},{"title":"Step 4 \u2014 Check Deal Status","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/loans/clx1a2b3c4d5e6f7g8h9 \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"status\": \"QC_COMPLETED\"\n }\n}"},{"md":"

Deal status lifecycle:

Status	Meaning
`DRAFT`	Upload URL issued, file not yet submitted
`IN_REVIEW`	File submitted, under platform review
`QC_COMPLETED`	Quality check passed
`APPROVED`	Deal approved for securitization
`REJECTED`	Deal rejected \u2014 check reason in response

"}]}],"slug":"create-a-deal"},{"title":"Run Selection Criteria","description":"Validate your loan tape against eligibility rules, fetch results, and inspect exceptions.","icon":"list-checks","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Trigger a Selection Criteria Run","request":"curl -X POST https://api.9squid.com/v1/api/originator/sc/run \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"loan_id\": \"clx1a2b3c4d5e6f7g8h9\" }'","response":"{\n \"success\": true,\n \"data\": {\n \"sc_job_id\": \"clxjob123456\"\n }\n}","content":[{"md":"

Pass the loan_id (deal ID) to validate. The SC job runs asynchronously \u2014 results are available once it completes.

"},{"title":"Step 1 \u2014 Trigger a Selection Criteria Run","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/sc/run \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"loan_id\": \"clx1a2b3c4d5e6f7g8h9\" }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"sc_job_id\": \"clxjob123456\"\n }\n}"}]},{"title":"Step 2 \u2014 Fetch Results for a Deal","request":"curl https://api.9squid.com/v1/api/originator/sc/loans/clx1a2b3c4d5e6f7g8h9/results \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"sc_job_id\": \"clxjob123456\",\n \"run_date\": \"2026-04-15T10:00:00Z\",\n \"pass\": false,\n \"exception_count\": 2,\n \"results\": [\n { \"field\": \"fico_score\", \"rule\": \"min_fico_700\", \"passed\": false },\n { \"field\": \"ltv\", \"rule\": \"max_ltv_80\", \"passed\": true },\n { \"field\": \"dti\", \"rule\": \"max_dti_45\", \"passed\": false }\n ]\n }\n ]\n}","content":[{"title":"Step 2 \u2014 Fetch Results","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/sc/loans/clx1a2b3c4d5e6f7g8h9/results \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"sc_job_id\": \"clxjob123456\",\n \"run_date\": \"2026-04-15T10:00:00Z\",\n \"pass\": false,\n \"exception_count\": 2,\n \"results\": [\n { \"field\": \"fico_score\", \"rule\": \"min_fico_700\", \"passed\": false },\n { \"field\": \"ltv\", \"rule\": \"max_ltv_80\", \"passed\": true },\n { \"field\": \"dti\", \"rule\": \"max_dti_45\", \"passed\": false }\n ]\n }\n ]\n}"},{"md":"

Each run creates a new job \u2014 results are tracked per sc_job_id so you have a full history.

"}]},{"title":"Step 3 \u2014 List All Exceptions","request":"curl https://api.9squid.com/v1/api/originator/sc/exceptions \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"clxexc789\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"sc_job_id\": \"clxjob123456\",\n \"exception_count\": 2,\n \"created_at\": \"2026-04-15T10:00:00Z\"\n }\n ]\n}","content":[{"md":"

View all exception files across all SC runs for your organization.

"},{"title":"Step 3 \u2014 List Exceptions","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/sc/exceptions \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"clxexc789\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"sc_job_id\": \"clxjob123456\",\n \"exception_count\": 2,\n \"created_at\": \"2026-04-15T10:00:00Z\"\n }\n ]\n}"}]},{"title":"Step 4 \u2014 Inspect Exception Detail","request":"curl https://api.9squid.com/v1/api/originator/sc/exceptions/clxexc789 \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"id\": \"clxexc789\",\n \"loan_data\": {},\n \"exception_history\": [\n {\n \"field\": \"fico_score\",\n \"rule\": \"min_fico_700\",\n \"actual_value\": 680,\n \"threshold\": 700,\n \"passed\": false\n }\n ]\n }\n}","content":[{"md":"

Drill into a specific exception to see the rule, actual value, and threshold that failed.

"},{"title":"Step 4 \u2014 Inspect Exception Detail","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/sc/exceptions/clxexc789 \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"id\": \"clxexc789\",\n \"loan_data\": {},\n \"exception_history\": [\n {\n \"field\": \"fico_score\",\n \"rule\": \"min_fico_700\",\n \"actual_value\": 680,\n \"threshold\": 700,\n \"passed\": false\n }\n ]\n }\n}"},{"md":"

After correcting your loan data, re-upload the tape and trigger a fresh SC run with the same loan_id.

"}]}],"slug":"run-selection-criteria"},{"title":"Bulk Loan Upload","description":"Submit multiple loan tapes in a single job with per-deal upload URLs and independent status tracking.","icon":"cloud-upload","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Initiate a Bulk Upload Job","request":"curl -X POST https://api.9squid.com/v1/api/originator/loans/bulk \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n { \"type\": \"Auto\" },\n { \"type\": \"Mortgage\" }\n ]'","response":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"files\": [\n {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-abc123.upload\",\n \"expires_in\": 3600\n },\n {\n \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-def456.upload\",\n \"expires_in\": 3600\n }\n ]\n }\n}","content":[{"md":"

Send an array of loan type entries. Each deal is created in DRAFT status with its own upload URL valid for 1 hour.

Supported loan types: Auto, Personal, Mortgage, Student, Business, Credit Card

"},{"title":"Step 1 \u2014 Initiate a Bulk Upload Job","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/loans/bulk \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n { \"type\": \"Auto\" },\n { \"type\": \"Mortgage\" }\n ]'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"files\": [\n {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-abc123.upload\",\n \"expires_in\": 3600\n },\n {\n \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\",\n \"upload_url\": \"https://api.9squid.com/v1/api/originator/loans/upload?u=\",\n \"file_name\": \"loan-tape-def456.upload\",\n \"expires_in\": 3600\n }\n ]\n }\n}"}]},{"title":"Step 2 \u2014 Upload Each File","request":"# Auto loan tape\ncurl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @auto-loans-q2.csv\n\n# Mortgage loan tape\ncurl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @mortgage-loans-q2.csv","response":"{\n \"success\": true,\n \"file_path\": \"upload/documents/deals/clx1a2b3c4d5e6f7g8h9/loan-tape-abc123.upload\"\n}","content":[{"md":"

Upload each file to its corresponding upload_url. The URL routes through the platform gateway \u2014 include your Authorization header and Content-Length as with any other request.

"},{"title":"Step 2 \u2014 Upload Files","lang":"bash","code":"# Auto loan tape\ncurl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @auto-loans-q2.csv\n\n# Mortgage loan tape\ncurl -X PUT \"\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Length: \" \\\n --data-binary @mortgage-loans-q2.csv"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"file_path\": \"upload/documents/deals/clx1a2b3c4d5e6f7g8h9/loan-tape-abc123.upload\"\n}"},{"md":"

Upload all files before calling complete. Any deal without an uploaded file will fail validation.

Upload URLs expire in 1 hour. Call PATCH /originator/loans/bulk/:jobId to regenerate fresh URLs for all DRAFT deals in the job.

"}]},{"title":"Step 3 \u2014 Complete the Bulk Job","request":"curl -X POST https://api.9squid.com/v1/api/originator/loans/bulk/complete \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"bulk_job_id\": \"clxbulk987654\",\n \"loans\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"file_name\": \"loan-tape-abc123.upload\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"file_name\": \"loan-tape-def456.upload\" }\n ]\n }'","response":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"results\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"deal_status\": \"IN_REVIEW\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"deal_status\": \"IN_REVIEW\" }\n ]\n }\n}","content":[{"md":"

Pass each deal_id and file_name from Step 1. The gateway fetches file metadata, registers each file, and marks all deals as IN_REVIEW.

"},{"title":"Step 3 \u2014 Complete the Bulk Job","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/loans/bulk/complete \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"bulk_job_id\": \"clxbulk987654\",\n \"loans\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"file_name\": \"loan-tape-abc123.upload\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"file_name\": \"loan-tape-def456.upload\" }\n ]\n }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"results\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"deal_status\": \"IN_REVIEW\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"deal_status\": \"IN_REVIEW\" }\n ]\n }\n}"}]},{"title":"Step 4 \u2014 Poll Bulk Job Status","request":"curl https://api.9squid.com/v1/api/originator/loans/bulk/clxbulk987654 \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"deals\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"deal_status\": \"QC_COMPLETED\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"deal_status\": \"IN_REVIEW\" }\n ]\n }\n}","content":[{"title":"Step 4 \u2014 Poll Status","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/loans/bulk/clxbulk987654 \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"bulk_job_id\": \"clxbulk987654\",\n \"deals\": [\n { \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\", \"deal_status\": \"QC_COMPLETED\" },\n { \"deal_id\": \"clx9z8y7x6w5v4u3t2s1\", \"deal_status\": \"IN_REVIEW\" }\n ]\n }\n}"},{"md":"

Bulk Status	Meaning
`PROCESSING`	Files submitted, deals being validated
`COMPLETED`	All deals processed \u2014 check individual statuses
`PARTIAL`	Some deals failed validation

"}]}],"slug":"bulk-loan-upload"},{"title":"ALM Analytics","description":"Trigger a TCT Risk ALM analysis on a deal and retrieve duration, convexity, NII sensitivity, VaR, and stress test results.","icon":"chart-line","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Trigger an ALM Analysis","request":"curl -X POST https://api.9squid.com/v1/api/originator/analytics/alm \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\" }'","response":"{\n \"success\": true,\n \"data\": {\n \"job_id\": \"clxalm001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"status\": \"PROCESSING\"\n }\n}","content":[{"md":"

Pass the deal_id to analyse. The job runs asynchronously and returns a job reference immediately.

"},{"title":"Step 1 \u2014 Trigger an ALM Analysis","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/originator/analytics/alm \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\" }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"job_id\": \"clxalm001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"status\": \"PROCESSING\"\n }\n}"}]},{"title":"Step 2 \u2014 Retrieve the Analysis Report","request":"curl https://api.9squid.com/v1/api/originator/analytics/alm/clxalm001 \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"job_id\": \"clxalm001\",\n \"status\": \"COMPLETED\",\n \"report\": {\n \"duration_metrics\": {\n \"macaulay_duration\": 4.2,\n \"modified_duration\": 3.9,\n \"dollar_duration\": 1850000\n },\n \"convexity\": 18.3,\n \"nii_sensitivity\": {\n \"shock_up_100bps\": -125000,\n \"shock_up_200bps\": -260000,\n \"shock_down_100bps\": 118000\n },\n \"eve_analysis\": {\n \"base\": 4200000,\n \"shock_up_200bps\": 3850000,\n \"shock_down_200bps\": 4510000\n },\n \"var_metrics\": {\n \"var_95\": 210000,\n \"var_99\": 340000\n },\n \"stress_tests\": [\n { \"scenario\": \"rate_shock_300bps\", \"impact\": -480000 },\n { \"scenario\": \"credit_stress\", \"impact\": -310000 }\n ]\n }\n }\n}","content":[{"md":"

Fetch the completed report by job_id. Includes all metric categories.

"},{"title":"Step 2 \u2014 Retrieve the Report","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/analytics/alm/clxalm001 \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"job_id\": \"clxalm001\",\n \"status\": \"COMPLETED\",\n \"report\": {\n \"duration_metrics\": {\n \"macaulay_duration\": 4.2,\n \"modified_duration\": 3.9,\n \"dollar_duration\": 1850000\n },\n \"convexity\": 18.3,\n \"nii_sensitivity\": {\n \"shock_up_100bps\": -125000,\n \"shock_up_200bps\": -260000,\n \"shock_down_100bps\": 118000\n },\n \"eve_analysis\": {\n \"base\": 4200000,\n \"shock_up_200bps\": 3850000,\n \"shock_down_200bps\": 4510000\n },\n \"var_metrics\": {\n \"var_95\": 210000,\n \"var_99\": 340000\n },\n \"stress_tests\": [\n { \"scenario\": \"rate_shock_300bps\", \"impact\": -480000 },\n { \"scenario\": \"credit_stress\", \"impact\": -310000 }\n ]\n }\n }\n}"},{"md":"

Section	What it tells you
`duration_metrics`	Price sensitivity to interest rate moves
`convexity`	Curvature of the price-yield relationship
`nii_sensitivity`	Net Interest Income change under rate shocks
`eve_analysis`	Economic Value of Equity under rate scenarios
`var_metrics`	Value-at-Risk at 95% and 99% confidence
`stress_tests`	Portfolio impact under defined stress scenarios

"}]}],"slug":"alm-analytics"},{"title":"Pool Analytics","description":"Browse securitization pools, fetch aggregate statistics, and pull full pool reports.","icon":"chart-pie","color":"#FFF500","steps":[{"title":"Step 1 \u2014 List Your Pools","request":"curl https://api.9squid.com/v1/api/originator/pools \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"pool_id\": \"clxpool001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"asset_type\": \"Auto\",\n \"loan_count\": 1240,\n \"total_balance\": 48500000,\n \"created_at\": \"2026-04-01T00:00:00Z\"\n }\n ]\n}","content":[{"md":"

Returns all securitization pools associated with your organization.

"},{"title":"Step 1 \u2014 List Your Pools","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/pools \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"pool_id\": \"clxpool001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"asset_type\": \"Auto\",\n \"loan_count\": 1240,\n \"total_balance\": 48500000,\n \"created_at\": \"2026-04-01T00:00:00Z\"\n }\n ]\n}"}]},{"title":"Step 2 \u2014 Pool Summary Statistics","request":"curl https://api.9squid.com/v1/api/originator/pools/clxpool001/summary \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"total_balance\": 48500000,\n \"loan_count\": 1240,\n \"wa_coupon\": 6.85,\n \"wa_maturity\": 54.2,\n \"wa_ltv\": 72.4,\n \"wa_fico\": 718,\n \"wa_dti\": 38.1,\n \"wa_seasoning\": 8.3,\n \"balance_stats\": { \"min\": 4200, \"max\": 95000, \"avg\": 39112 },\n \"delinquency_breakdown\": {\n \"current\": 94.2,\n \"30_days\": 3.8,\n \"60_days\": 1.4,\n \"90_plus_days\": 0.6\n },\n \"geographic_top_5\": [\n { \"state\": \"CA\", \"pct\": 22.1 },\n { \"state\": \"TX\", \"pct\": 14.3 },\n { \"state\": \"FL\", \"pct\": 11.8 }\n ],\n \"vintage_distribution\": {\n \"2023\": 18.4,\n \"2024\": 51.2,\n \"2025\": 30.4\n }\n }\n}","content":[{"md":"

The summary endpoint returns key aggregate metrics in a single call.

"},{"title":"Step 2 \u2014 Pool Summary","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/pools/clxpool001/summary \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"total_balance\": 48500000,\n \"loan_count\": 1240,\n \"wa_coupon\": 6.85,\n \"wa_maturity\": 54.2,\n \"wa_ltv\": 72.4,\n \"wa_fico\": 718,\n \"wa_dti\": 38.1,\n \"wa_seasoning\": 8.3,\n \"balance_stats\": { \"min\": 4200, \"max\": 95000, \"avg\": 39112 },\n \"delinquency_breakdown\": {\n \"current\": 94.2,\n \"30_days\": 3.8,\n \"60_days\": 1.4,\n \"90_plus_days\": 0.6\n },\n \"geographic_top_5\": [\n { \"state\": \"CA\", \"pct\": 22.1 },\n { \"state\": \"TX\", \"pct\": 14.3 },\n { \"state\": \"FL\", \"pct\": 11.8 }\n ],\n \"vintage_distribution\": {\n \"2023\": 18.4,\n \"2024\": 51.2,\n \"2025\": 30.4\n }\n }\n}"}]},{"title":"Step 3 \u2014 Full Pool Report","request":"curl https://api.9squid.com/v1/api/originator/pools/clxpool001/report \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": { }\n}","content":[{"title":"Step 3 \u2014 Full Pool Report","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/pools/clxpool001/report \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": { }\n}"}]},{"title":"Step 4 \u2014 Find Pool by Deal ID","request":"curl https://api.9squid.com/v1/api/originator/pools/deal/clx1a2b3c4d5e6f7g8h9 \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"pool_id\": \"clxpool001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"total_balance\": 48500000,\n \"loan_count\": 1240\n }\n}","content":[{"md":"

If you know the deal but not the pool ID, look it up directly.

"},{"title":"Step 4 \u2014 Find Pool by Deal","lang":"bash","code":"curl https://api.9squid.com/v1/api/originator/pools/deal/clx1a2b3c4d5e6f7g8h9 \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"pool_id\": \"clxpool001\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"total_balance\": 48500000,\n \"loan_count\": 1240\n }\n}"},{"md":"

Metric	Description
`wa_coupon`	Weighted average interest rate across all loans
`wa_maturity`	Weighted average remaining term in months
`wa_ltv`	Weighted average loan-to-value ratio
`wa_fico`	Weighted average borrower credit score
`wa_dti`	Weighted average debt-to-income ratio
`wa_seasoning`	Weighted average months since origination

"}]}],"slug":"pool-analytics"},{"title":"Investor Deal Subscription","description":"Browse the deal marketplace, submit an indication of interest, commit to a subscription, and track allocation status.","icon":"clipboard-check","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Browse Available Deals","request":"curl https://api.9squid.com/v1/api/investor/deals \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"asset_type\": \"Auto\",\n \"total_balance\": 48500000,\n \"loan_count\": 1240,\n \"wa_fico\": 718,\n \"status\": \"OPEN\",\n \"tranches\": [\n { \"tranche_id\": \"clxtranche01\", \"name\": \"Senior A\", \"rating\": \"AAA\", \"yield\": 5.2 },\n { \"tranche_id\": \"clxtranche02\", \"name\": \"Mezzanine B\", \"rating\": \"BBB\", \"yield\": 7.8 }\n ]\n }\n ]\n}","content":[{"md":"

Returns a paginated list of all deals currently open for investment with metrics and tranche overview.

"},{"title":"Step 1 \u2014 Browse Available Deals","lang":"bash","code":"curl https://api.9squid.com/v1/api/investor/deals \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"asset_type\": \"Auto\",\n \"total_balance\": 48500000,\n \"loan_count\": 1240,\n \"wa_fico\": 718,\n \"status\": \"OPEN\",\n \"tranches\": [\n { \"tranche_id\": \"clxtranche01\", \"name\": \"Senior A\", \"rating\": \"AAA\", \"yield\": 5.2 },\n { \"tranche_id\": \"clxtranche02\", \"name\": \"Mezzanine B\", \"rating\": \"BBB\", \"yield\": 7.8 }\n ]\n }\n ]\n}"}]},{"title":"Step 2 \u2014 Inspect Deal Details","request":"# Tranches\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/tranches \\\n -H \"Authorization: Bearer \"\n\n# Pool statistics\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/pool \\\n -H \"Authorization: Bearer \"\n\n# Deal room documents\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/documents \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": { }\n}","content":[{"md":"

Review the full deal before committing \u2014 pool stats, tranches, documents, and originator profile.

"},{"title":"Step 2 \u2014 Inspect Deal Details","lang":"bash","code":"# Tranches\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/tranches \\\n -H \"Authorization: Bearer \"\n\n# Pool statistics\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/pool \\\n -H \"Authorization: Bearer \"\n\n# Deal room documents\ncurl https://api.9squid.com/v1/api/investor/deals/clx1a2b3c4d5e6f7g8h9/documents \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": { }\n}"}]},{"title":"Step 3 \u2014 Submit Indication of Interest","request":"curl -X POST https://api.9squid.com/v1/api/investor/subscriptions/ioi \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"indicated_amount\": 1000000\n }'","response":"{\n \"success\": true,\n \"data\": {\n \"ioi_id\": \"clxioi001\",\n \"status\": \"RECEIVED\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"indicated_amount\": 1000000\n }\n}","content":[{"md":"

Signal interest without a formal commitment. Non-binding \u2014 lets the originator gauge demand.

"},{"title":"Step 3 \u2014 Submit IOI","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/investor/subscriptions/ioi \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"indicated_amount\": 1000000\n }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"ioi_id\": \"clxioi001\",\n \"status\": \"RECEIVED\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"indicated_amount\": 1000000\n }\n}"}]},{"title":"Step 4 \u2014 Submit Formal Subscription","request":"curl -X POST https://api.9squid.com/v1/api/investor/subscriptions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"amount\": 1000000\n }'","response":"{\n \"success\": true,\n \"data\": {\n \"subscription_id\": \"clxsub001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"compliance_check_result\": \"PASSED\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"amount\": 1000000\n }\n}","content":[{"md":"

Commit to the deal. The platform runs compliance checks automatically.

"},{"title":"Step 4 \u2014 Submit Subscription","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/investor/subscriptions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"amount\": 1000000\n }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"subscription_id\": \"clxsub001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"compliance_check_result\": \"PASSED\",\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"tranche_id\": \"clxtranche01\",\n \"amount\": 1000000\n }\n}"}]},{"title":"Step 5 \u2014 Check Allocations","request":"curl https://api.9squid.com/v1/api/investor/subscriptions/allocations \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"allocation_id\": \"clxalloc001\",\n \"subscription_id\": \"clxsub001\",\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"allocated_quantity\": 1000000,\n \"price\": 98.5,\n \"settlement_date\": \"2026-05-01T00:00:00Z\",\n \"status\": \"PENDING_SETTLEMENT\"\n }\n ]\n}","content":[{"md":"

Once confirmed, your allocation appears here with quantity and settlement details.

"},{"title":"Step 5 \u2014 Check Allocations","lang":"bash","code":"curl https://api.9squid.com/v1/api/investor/subscriptions/allocations \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"allocation_id\": \"clxalloc001\",\n \"subscription_id\": \"clxsub001\",\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"allocated_quantity\": 1000000,\n \"price\": 98.5,\n \"settlement_date\": \"2026-05-01T00:00:00Z\",\n \"status\": \"PENDING_SETTLEMENT\"\n }\n ]\n}"},{"md":"

Status	Meaning
`PENDING_CONFIRMATION`	Awaiting originator confirmation
`CONFIRMED`	Accepted \u2014 allocation in progress
`ALLOCATED`	Units allocated to your account
`REJECTED`	Subscription rejected

"}]}],"slug":"investor-deal-subscription"},{"title":"Investor Portfolio Reports","description":"Fetch current holdings, trade history, tranche performance metrics, and pool analytics in one call.","icon":"trending-up","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Fetch Holdings","request":"curl https://api.9squid.com/v1/api/investor/portfolio \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"trade_id\": \"clxtr001\",\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"deal_id\": \"clxdeal001\",\n \"allocated_quantity\": 500000,\n \"price\": 98.5,\n \"settlement_date\": \"2026-03-01T00:00:00Z\",\n \"status\": \"SETTLED\"\n }\n ]\n}","content":[{"md":"

Returns all tranches you currently hold with quantity and tranche details.

"},{"title":"Step 1 \u2014 Fetch Holdings","lang":"bash","code":"curl https://api.9squid.com/v1/api/investor/portfolio \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"trade_id\": \"clxtr001\",\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"deal_id\": \"clxdeal001\",\n \"allocated_quantity\": 500000,\n \"price\": 98.5,\n \"settlement_date\": \"2026-03-01T00:00:00Z\",\n \"status\": \"SETTLED\"\n }\n ]\n}"}]},{"title":"Step 2 \u2014 Portfolio Summary","request":"curl https://api.9squid.com/v1/api/investor/portfolio/summary \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"total_invested\": 2500000,\n \"total_holdings\": 4,\n \"active_deals\": 2,\n \"settled_trades\": 3,\n \"pending_trades\": 1\n }\n}","content":[{"md":"

Aggregated totals across all your holdings \u2014 useful for a dashboard view.

"},{"title":"Step 2 \u2014 Portfolio Summary","lang":"bash","code":"curl https://api.9squid.com/v1/api/investor/portfolio/summary \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"total_invested\": 2500000,\n \"total_holdings\": 4,\n \"active_deals\": 2,\n \"settled_trades\": 3,\n \"pending_trades\": 1\n }\n}"}]},{"title":"Step 3 \u2014 Full Portfolio Report","request":"curl https://api.9squid.com/v1/api/investor/portfolio/reports \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"holdings\": [\n {\n \"trade_id\": \"clxtr001\",\n \"tranche_name\": \"Senior A\",\n \"allocated_quantity\": 500000,\n \"status\": \"SETTLED\"\n }\n ],\n \"trade_history\": [\n {\n \"trade_id\": \"clxtr001\",\n \"quantity\": 500000,\n \"price\": 98.5,\n \"trade_date\": \"2026-02-28T14:00:00Z\",\n \"status\": \"SETTLED\"\n }\n ],\n \"tranche_performance\": [\n {\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"deal_id\": \"clxdeal001\",\n \"metrics\": {}\n }\n ],\n \"pool_metrics\": [\n {\n \"deal_id\": \"clxdeal001\",\n \"metrics\": {}\n }\n ]\n }\n}","content":[{"md":"

All data in one call: holdings, trade history, tranche performance, and pool metrics from the latest completed ALM job.

"},{"title":"Step 3 \u2014 Full Report","lang":"bash","code":"curl https://api.9squid.com/v1/api/investor/portfolio/reports \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"holdings\": [\n {\n \"trade_id\": \"clxtr001\",\n \"tranche_name\": \"Senior A\",\n \"allocated_quantity\": 500000,\n \"status\": \"SETTLED\"\n }\n ],\n \"trade_history\": [\n {\n \"trade_id\": \"clxtr001\",\n \"quantity\": 500000,\n \"price\": 98.5,\n \"trade_date\": \"2026-02-28T14:00:00Z\",\n \"status\": \"SETTLED\"\n }\n ],\n \"tranche_performance\": [\n {\n \"tranche_id\": \"clxtranche01\",\n \"tranche_name\": \"Senior A\",\n \"deal_id\": \"clxdeal001\",\n \"metrics\": {}\n }\n ],\n \"pool_metrics\": [\n {\n \"deal_id\": \"clxdeal001\",\n \"metrics\": {}\n }\n ]\n }\n}"},{"md":"

tranche_performance and pool_metrics are populated from the latest completed ALM calculation job. If no job has completed for a deal, those arrays will be empty for that deal.

"}]}],"slug":"investor-portfolio"},{"title":"Webhooks","description":"Subscribe to real-time platform events, verify signatures, replay failed deliveries, and manage subscriptions.","icon":"webhook","color":"#FFF500","steps":[{"title":"Step 1 \u2014 Create a Subscription","request":"curl -X POST https://api.9squid.com/v1/api/webhooks/subscriptions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"url\": \"https://your-server.com/webhooks/9squid\",\n \"events\": [\"deal.status_changed\", \"loan.approved\", \"trade.settled\"]\n }'","response":"{\n \"success\": true,\n \"data\": {\n \"id\": \"clxsub001\",\n \"url\": \"https://your-server.com/webhooks/9squid\",\n \"events\": [\"deal.status_changed\", \"loan.approved\", \"trade.settled\"],\n \"secret\": \"whsec_abc123xyz\",\n \"created_at\": \"2026-04-15T10:00:00Z\"\n }\n}","content":[{"md":"

Point the platform at your endpoint and specify which events to receive. Save the secret \u2014 it's shown only once and is used to verify signatures on incoming requests.

Event	Triggered when
`deal.status_changed`	A deal moves to a new status
`loan.approved`	A loan deal is approved for securitization
`loan.rejected`	A loan deal is rejected
`trade.settled`	An investor trade reaches settlement
`sc.completed`	A Selection Criteria job finishes
`document.uploaded`	A document is uploaded to the deal room

"},{"title":"Step 1 \u2014 Create a Subscription","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/webhooks/subscriptions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"url\": \"https://your-server.com/webhooks/9squid\",\n \"events\": [\"deal.status_changed\", \"loan.approved\", \"trade.settled\"]\n }'"},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"id\": \"clxsub001\",\n \"url\": \"https://your-server.com/webhooks/9squid\",\n \"events\": [\"deal.status_changed\", \"loan.approved\", \"trade.settled\"],\n \"secret\": \"whsec_abc123xyz\",\n \"created_at\": \"2026-04-15T10:00:00Z\"\n }\n}"}]},{"title":"Step 2 \u2014 View Delivery History","request":"curl https://api.9squid.com/v1/api/webhooks/deliveries \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"clxdlv001\",\n \"event\": \"deal.status_changed\",\n \"status\": \"DELIVERED\",\n \"http_status\": 200,\n \"attempts\": 1,\n \"created_at\": \"2026-04-15T11:00:00Z\"\n },\n {\n \"id\": \"clxdlv002\",\n \"event\": \"loan.approved\",\n \"status\": \"FAILED\",\n \"http_status\": 503,\n \"attempts\": 3,\n \"created_at\": \"2026-04-15T11:05:00Z\"\n }\n ]\n}","content":[{"md":"

Check which events have been delivered and whether they succeeded.

"},{"title":"Step 2 \u2014 View Delivery History","lang":"bash","code":"curl https://api.9squid.com/v1/api/webhooks/deliveries \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"clxdlv001\",\n \"event\": \"deal.status_changed\",\n \"status\": \"DELIVERED\",\n \"http_status\": 200,\n \"attempts\": 1,\n \"created_at\": \"2026-04-15T11:00:00Z\"\n },\n {\n \"id\": \"clxdlv002\",\n \"event\": \"loan.approved\",\n \"status\": \"FAILED\",\n \"http_status\": 503,\n \"attempts\": 3,\n \"created_at\": \"2026-04-15T11:05:00Z\"\n }\n ]\n}"}]},{"title":"Step 3 \u2014 Replay a Failed Delivery","request":"curl -X POST https://api.9squid.com/v1/api/webhooks/deliveries/clxdlv002/replay \\\n -H \"Authorization: Bearer \"","response":"{\n \"success\": true,\n \"data\": {\n \"delivery_id\": \"clxdlv003\",\n \"status\": \"PENDING\"\n }\n}","content":[{"md":"

If your server was down or returned a non-2xx, trigger a replay.

"},{"title":"Step 3 \u2014 Replay Failed Delivery","lang":"bash","code":"curl -X POST https://api.9squid.com/v1/api/webhooks/deliveries/clxdlv002/replay \\\n -H \"Authorization: Bearer \""},{"title":"Response","lang":"json","code":"{\n \"success\": true,\n \"data\": {\n \"delivery_id\": \"clxdlv003\",\n \"status\": \"PENDING\"\n }\n}"}]},{"title":"Step 4 \u2014 Verify Webhook Signatures","request":"const crypto = require('crypto');\n\nfunction verifyWebhook(payload, signature, secret) {\n const expected = crypto\n .createHmac('sha256', secret)\n .update(payload)\n .digest('hex');\n return crypto.timingSafeEqual(\n Buffer.from(signature),\n Buffer.from(`sha256=${expected}`)\n );\n}","response":"{\n \"event\": \"deal.status_changed\",\n \"timestamp\": \"2026-04-15T11:00:00Z\",\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"previous_status\": \"IN_REVIEW\",\n \"current_status\": \"QC_COMPLETED\"\n }\n}","content":[{"md":"

Every delivery includes an X-9Squid-Signature header. Verify it using the secret from Step 1.

"},{"title":"Step 4 \u2014 Verify Signature (Node.js)","lang":"bash","code":"const crypto = require('crypto');\n\nfunction verifyWebhook(payload, signature, secret) {\n const expected = crypto\n .createHmac('sha256', secret)\n .update(payload)\n .digest('hex');\n return crypto.timingSafeEqual(\n Buffer.from(signature),\n Buffer.from(`sha256=${expected}`)\n );\n}"},{"title":"Webhook Payload Shape","lang":"json","code":"{\n \"event\": \"deal.status_changed\",\n \"timestamp\": \"2026-04-15T11:00:00Z\",\n \"data\": {\n \"deal_id\": \"clx1a2b3c4d5e6f7g8h9\",\n \"previous_status\": \"IN_REVIEW\",\n \"current_status\": \"QC_COMPLETED\"\n }\n}"},{"md":"

Always reject requests where the signature does not match.

"}]}],"slug":"webhooks"}]; /* ---------- card icons ---------- Lucide, inlined. Lucide is already the icon language of this site — Mintlify draws the navbar and sidebar with it, and the home page path cards use the same 24px/2px-stroke geometry — so the recipe cards now match rather than sitting in a separate emoji vocabulary that rendered differently on every OS. Inlined rather than imported: there is no bundler here, and a