{"info":{"_postman_id":"4a6d35db-c5ae-4b22-984f-d31c2c43b002","name":"LawVo - Inbound API","description":"

LawVo inbound partner API

This collection covers inbound partner endpoints:

POST /generate-sso-link - one-time member login URL
GET /inbound/document-templates - paginated document template catalog (Basic Information metadata)

Partner guides:

Setup

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Value
`baseUrl`	UAT: `https://stagingapi.lawvo.com` · Live: `https://api.lawvo.com` (no trailing slash)
`PARTNER_API_KEY`	Inbound API key from LawVo
`PARTNER_HMAC_SECRET`	Paired HMAC secret
`documentTemplatesCategoryId`	Category id for filter examples (folder 6)
`documentTemplatesTagId`	Tag id for filter examples (folder 6)

POST requests sign the exact raw JSON body. GET /inbound/document-templates signs GET\\n/inbound/document-templates\\n<canonical query> where the query is sorted by parameter name.

Every authenticated request requires both X-API-Key (or Bearer) and X-Webhook-Signature: sha256=<hex>.

Supported `origin` slugs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`origin` slug	LawVo section	App path after login
`dashboard`	Dashboard	`/dashboard`
`legal_ai`	LawVo AI	`/legal-ai`
`knowledge_center`	Knowledge Center	`/subgroups`
`document_hub`	Document Hub	`/document-center/?key=3`
`document_library`	Document Library	`/document-library`
`wills`	Wills	`/wills`
`legal_support`	24/7 Legal Help	`/legal-support`
`settings`	Settings	`/settings`

Supported `landingContext.serviceCategory` slugs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`serviceCategory` slug	Document Hub category
`will`	Wills
`wills`	Wills
`real_estate`	Real Estate
`realestate`	Real Estate
`family`	Family
`business`	Business
`employment`	Employment
`corporate`	Corporate
`immigration`	Immigration
(any normalized category name)	e.g. `Real Estate` -> `real_estate`

HTTP responses (SSO)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
200	`{ \"loginUrl\": \"...\" }`
400	Validation
401	Missing/wrong API key or HMAC
403	IP allowlist or SSO Login disabled
404	API key not recognized
409	Email is non-customer account

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"LawVo inbound partner API","slug":"lawvo-inbound-partner-api"}],"owner":"55612606","collectionId":"4a6d35db-c5ae-4b22-984f-d31c2c43b002","publishedId":"2sBY4Mu1my","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-07-14T23:18:48.000Z"},"item":[{"name":"1. Quick start","item":[{"name":"Generate SSO link (required fields only)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"d17add2a-672f-493e-a454-bb4fa7805456"}}],"id":"776d093f-3e66-4925-bb3c-de66caa8dfac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\"\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Smallest valid payload. No metaData, origin, or landingContext.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"776d093f-3e66-4925-bb3c-de66caa8dfac"},{"name":"Open one-time login URL (browser)","id":"542619d2-7339-4c9d-9885-45d7b0f4e917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Run after a 200 generate. Enable Follow redirects in Postman.

Opens loginUrl once. Second open fails (token consumed).

\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"542619d2-7339-4c9d-9885-45d7b0f4e917"}],"id":"693e502b-a8c0-463b-bee6-a75ad65b0c44","description":"

Purpose

Smallest path to get a one-time loginUrl and open it in the browser.

Use case

First integration smoke test, or SSO-only login with no Document Hub extras.

Required inputs

API Access + SSO Login enabled. Collection variables baseUrl, PARTNER_API_KEY, PARTNER_HMAC_SECRET. Required body fields only.

Request example

Run Generate SSO link (required fields only), then Open one-time login URL.

Expected response

200 { \"loginUrl\": \"...\" }. Consume once; second open fails.

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
401	Bad key/HMAC
403	IP or SSO Login off
404	Unknown key / API Access off

Complete implementation flow

Set credentials.
Generate.
Open loginUrl once with Follow redirects enabled.

\n","_postman_id":"693e502b-a8c0-463b-bee6-a75ad65b0c44"},{"name":"2. metaData examples","item":[{"name":"metaData: full (all contexts)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"eef82693-941d-43c0-9a0e-12e776f2fc3d"}}],"id":"10b0a678-5cd3-43c3-b302-52c5a50a1275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"metaData\": {\n \"personal\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"phoneNumber\": \"4165550100\",\n \"emailAddress\": \"member.test+1784078655@example.com\",\n \"dateOfBirth\": \"1990-04-15\"\n },\n \"business\": [\n {\n \"name\": \"Primary business\",\n \"isDefault\": true,\n \"businessName\": \"Acme PM Ltd.\",\n \"businessAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Toronto\",\n \"province\": \"ON\",\n \"postalCode\": \"M5V 1A1\"\n },\n \"city\": \"Toronto\",\n \"province\": \"ON\",\n \"businessNumber\": \"123456789\",\n \"companyName\": \"Acme PM\",\n \"numberOfEmployees\": \"25\"\n }\n ],\n \"family\": [\n {\n \"name\": \"Jane Doe\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1985-06-20\"\n }\n ],\n \"employee\": [\n {\n \"name\": \"John Smith\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"john.smith@acme.com\"\n }\n ]\n }\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Canonical full prefill payload (all contexts).

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"10b0a678-5cd3-43c3-b302-52c5a50a1275"},{"name":"metaData: personal only","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"8ca288e2-ee01-4cab-a930-35b47e29fb30"}}],"id":"1e4bd4f2-54ae-4a1e-a3f8-c94cd50bd820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"metaData\": {\n \"personal\": {\n \"dateOfBirth\": \"1992-08-10\"\n }\n }\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Minimal personal prefill. Top-level identity merges into personal when present.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e4bd4f2-54ae-4a1e-a3f8-c94cd50bd820"}],"id":"30073c2a-4107-4146-acb5-62f63f0ca5b0","description":"

Purpose

Optional metaData on generate SSO to prefill Document Hub personal/business/family/employee fields.

Use case

Member already filled a profile on your site; you want those values ready in Document Hub after login.

Required inputs

Same SSO auth as Quick start. Known keys are type-validated; unknown keys are accepted and stored but not prefilled. Dates: YYYY-MM-DD. Array items need name.

Request example

metaData: full for all contexts, or metaData: personal only for a minimal personal block. Omit metaData or send {} for SSO-only.

Expected response

200 with loginUrl immediately. Prefill runs asynchronously (best effort) after the response.

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
400	Invalid known field (e.g. bad date) or array item missing `name`
401/403/404	Same as SSO auth

Other shapes (business-only, custom partner keys) follow the same request pattern; keep one full + one personal example here.

Complete implementation flow

Map your profile fields to known Document Hub keys.
POST generate with metaData.
Redirect member to loginUrl.
Confirm prefill in Document Hub after login.

\n","_postman_id":"30073c2a-4107-4146-acb5-62f63f0ca5b0"},{"name":"3. Post-login landing (origin)","item":[{"name":"origin: document_hub","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"6a6ec28b-ab38-4537-8138-77438df7b186"}}],"id":"5046d08d-1d6c-4509-a7f4-0698507055c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"origin\": \"document_hub\"\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Land on Document Hub after consume.

origin: document_hub
Expected path: /document-center/?key=3

Other supported slugs: see collection description table.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5046d08d-1d6c-4509-a7f4-0698507055c9"}],"id":"28689ec1-5cc3-4c6f-bd02-cee55fca4757","description":"

Purpose

Optional origin slug so the member lands on a LawVo section after SSO instead of the default dashboard.

Use case

Member clicked Document Hub (or another product area) on your site and should open that section after login.

Required inputs

Same SSO auth. origin must be a valid slug format. Supported slugs: dashboard, legal_ai, knowledge_center, document_hub, document_library, wills, legal_support, settings (see collection description table).

Request example

This folder keeps one runnable example: origin: document_hub. Other slugs use the same shape with a different origin value.

Expected response

200 { \"loginUrl\": \"...\" }. After consume, the app opens the mapped section. Unknown but valid slugs fall back to the role default dashboard.

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
400	Invalid origin format (e.g. path like `/evil-path`)
401/403/404	Same as SSO auth

Complete implementation flow

Choose the section slug from the supported table.
POST generate with origin.
Redirect to loginUrl once.
Confirm the member lands on the expected section.

\n","_postman_id":"28689ec1-5cc3-4c6f-bd02-cee55fca4757"},{"name":"4. Document Hub deep-links (landingContext)","item":[{"name":"landingContext: category filter only","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"5b167fe2-76e5-4a7b-8cee-b1bd06457001"}}],"id":"ccae22ea-dfa0-46c6-88f7-95f2a400b100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"origin\": \"document_hub\",\n \"landingContext\": {\n \"serviceCategory\": \"will\"\n }\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Filter My Templates to the Wills category. Uses slug will (not an internal id).

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccae22ea-dfa0-46c6-88f7-95f2a400b100"},{"name":"landingContext: create from template","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has loginUrl', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('loginUrl');"," pm.expect(json.loginUrl).to.include('/sso/consume/');"," pm.collectionVariables.set('lastLoginUrl', json.loginUrl);","});"],"id":"6e3df0d2-4ad6-4191-a56c-de785e80940c"}}],"id":"7a2fda30-1a9c-4d80-8b1d-cd6805cacd8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"origin\": \"document_hub\",\n \"landingContext\": {\n \"templateId\": 1,\n \"action\": \"create\"\n }\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Replace templateId with a template id from your environment. Opens guarded document creation.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a2fda30-1a9c-4d80-8b1d-cd6805cacd8b"},{"name":"landingContext: invalid inputs (400)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 400', () => pm.response.to.have.status(400));","pm.test('landingContext validation error', () => {"," const err = (pm.response.json() || {}).error || '';"," pm.expect(err).to.match(/serviceCategory|templateId/i);","});"],"id":"37c519ba-74ed-42ae-9832-c96a838cc4b5"}}],"id":"4bd15610-ad09-4a7c-95e1-93891c0f3137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"landingContext\": {\n \"serviceCategory\": \"123invalid\"\n }\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Example invalid serviceCategory (must match slug format). Invalid templateId (non-integer) also returns 400.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bd15610-ad09-4a7c-95e1-93891c0f3137"}],"id":"8acffcdd-3860-4c16-8125-c330c2caf891","description":"

Purpose

landingContext on generate SSO deep-links the member into Document Hub with a category filter or a create-from-template intent.

Use case

Member chose Wills (or Create Basic Will) on your site; after SSO they should see that category or start create for a known template.

Required inputs

Same SSO auth + SSO Login. Prefer origin: \"document_hub\". Fields: serviceCategory (slug), templateId (env-specific positive integer), action: \"create\" (requires templateId). Precedence: create intent > category filter > origin > dashboard. Category slugs: will/wills, real_estate, family, business, employment, corporate, immigration (or normalized category name).

Request example

Category filter uses serviceCategory: \"will\". Create from template uses templateId + action: \"create\" (replace id for your environment). If both are sent, create wins.

Expected response

200 with loginUrl. After consume: category filter selects that category; create opens My Templates with the template sidebar (disclaimer + access checks still apply).

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
400	Invalid `serviceCategory` slug format or non-integer `templateId`
401/403/404	Same as SSO auth

Unknown-but-valid category slugs still return 200; Document Hub shows all templates after login.

Complete implementation flow

Decide category browse vs create.
Resolve templateId for the target env if creating (GET /inbound/document-templates).
POST generate with landingContext.
Redirect to loginUrl once.
Confirm Document Hub landing behavior.

\n","_postman_id":"8acffcdd-3860-4c16-8125-c330c2caf891"},{"name":"5. Validation errors","item":[{"name":"missing email (400)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 400', () => pm.response.to.have.status(400));","pm.expect(pm.response.json().error).to.eql('email is required');"],"id":"57a98728-e490-4c48-a3ca-e823f7017e6d"}}],"id":"0ea18b76-fdc4-4fdd-ab38-21ce7c2b885c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\"\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Required field missing.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ea18b76-fdc4-4fdd-ab38-21ce7c2b885c"},{"name":"invalid origin path (400)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 400', () => pm.response.to.have.status(400));","pm.expect(pm.response.json().error || '').to.match(/origin/i);"],"id":"02b6a9d1-1128-4def-bf84-a717c5bd8550"}}],"id":"290647ac-8b46-4b2e-a7a1-0ecbaaa0bdbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"member.test+1784078655@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\",\n \"origin\": \"/evil-path\"\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Origin must be a slug, not a path.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"290647ac-8b46-4b2e-a7a1-0ecbaaa0bdbc"},{"name":"no auth headers (401)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 401', () => pm.response.to.have.status(401));"],"id":"afe1a263-406e-4d80-8e1f-9f72b0c11329"}}],"id":"1d182427-3307-454e-bfba-f314c6205d36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Member\",\n \"email\": \"noauth@example.com\",\n \"phone\": \"4165550100\",\n \"province\": \"ON\",\n \"city\": \"Toronto\"\n}"},"url":"https://stagingapi.lawvo.com/generate-sso-link","description":"

Missing API key and HMAC.

\n","urlObject":{"path":["generate-sso-link"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d182427-3307-454e-bfba-f314c6205d36"},{"name":"Open SSO consume URL (invalid token - 302 error)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 302', () => pm.response.to.have.status(302));","pm.test('Redirect with error', () => {"," const loc = pm.response.headers.get('Location') || '';"," pm.expect(loc).to.include('error=');","});"],"id":"d032feca-090d-477b-b4fa-5fb35685de48"}}],"id":"f6b3cbce-a8bd-4fd3-9b70-08ff4adc7c53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://stagingapi.lawvo.com/sso/consume/invalid-token-value-xyz","description":"

Consume endpoint. No partner auth. Invalid token redirects with error= query param.

\n","urlObject":{"path":["sso","consume","invalid-token-value-xyz"],"host":["https://stagingapi.lawvo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6b3cbce-a8bd-4fd3-9b70-08ff4adc7c53"}],"id":"ee9db09b-ca28-4471-a2d3-861718826a91","description":"

Purpose

Canonical failure examples for SSO generate and consume.

Use case

Verify your client handles validation and auth failures correctly.

Required inputs

Use valid auth except for no auth headers. Invalid origin / landingContext cases are covered here and in folder 4.

Request example

Run missing email, invalid origin path, no auth headers, and optionally the invalid consume URL.

Expected response

Expected 400, 401, or consume 302 with error= as noted per request.

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Example
400	Missing/invalid email; invalid origin path; bad metaData date
401	No auth headers
302	Invalid consume token redirects with `error=`

Complete implementation flow

Run each request.
Assert status and error message.
Fix your client validation to match.

\n","_postman_id":"ee9db09b-ca28-4471-a2d3-861718826a91"},{"name":"6. Document templates","item":[{"name":"List (default)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Response has data array and pagination', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('data');"," pm.expect(json.data).to.be.an(\"array\");"," pm.expect(json).to.have.property('pagination');"," pm.expect(json.pagination).to.have.property('total');"," if (json.data.length > 0) {"," const item = json.data[0];"," pm.expect(item).to.have.property('title');"," pm.expect(item).to.have.property('categories');"," pm.expect(item).to.not.have.property('effectivePermission');"," }","});"],"id":"aa0ab822-ea7b-42e1-990e-4f0a7eb184d7"}}],"id":"50fa5cfc-400c-41ad-86e2-995c6f212b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"","type":"text"}],"url":"https://stagingapi.lawvo.com/inbound/document-templates?locale=en&_start=0&_limit=25","description":"

English catalog page. Omit locale to return all locales. Returns data + pagination.

\n","urlObject":{"path":["inbound","document-templates"],"host":["https://stagingapi.lawvo.com"],"query":[{"key":"locale","value":"en"},{"key":"_start","value":"0"},{"key":"_limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"50fa5cfc-400c-41ad-86e2-995c6f212b7a"},{"name":"List with filters + pagination","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 200', () => pm.response.to.have.status(200));","pm.test('Has pagination', () => {"," const json = pm.response.json();"," pm.expect(json).to.have.property('pagination');"," pm.expect(json.data).to.be.an('array');","});"],"id":"dd7f1ac1-c697-4264-9c0d-f0d821ad8423"}}],"id":"ec79aa87-9bdb-44b0-b954-ed74d8122f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"","type":"text"}],"url":"https://stagingapi.lawvo.com/inbound/document-templates?locale=en&categoryId=3&page=1&pageSize=10","description":"

Filter by category and paginate with page / pageSize. Set documentTemplatesCategoryId. Tag filter uses tagId the same way (see markdown).

\n","urlObject":{"path":["inbound","document-templates"],"host":["https://stagingapi.lawvo.com"],"query":[{"key":"locale","value":"en"},{"key":"categoryId","value":"3"},{"key":"page","value":"1"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[],"_postman_id":"ec79aa87-9bdb-44b0-b954-ed74d8122f6a"},{"name":"no auth headers (401)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 401', () => pm.response.to.have.status(401));"],"id":"ffec0f59-5db0-40dc-9b9a-c6feb3fc10fa"}}],"id":"154a91a6-3602-429f-87ca-f0092f6a1834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://stagingapi.lawvo.com/inbound/document-templates?locale=en","description":"

Missing API key and HMAC.

\n","urlObject":{"path":["inbound","document-templates"],"host":["https://stagingapi.lawvo.com"],"query":[{"key":"locale","value":"en"}],"variable":[]}},"response":[],"_postman_id":"154a91a6-3602-429f-87ca-f0092f6a1834"},{"name":"Document Templates disabled (403)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status is 403', () => {"," const templatesOffKey = (pm.collectionVariables.get('PARTNER_API_KEY_TEMPLATES_OFF') || '').trim();"," const templatesOffSecret = (pm.collectionVariables.get('PARTNER_HMAC_SECRET_TEMPLATES_OFF') || '').trim();"," if (!templatesOffKey || !templatesOffSecret) {"," pm.expect.fail('Set PARTNER_API_KEY_TEMPLATES_OFF and PARTNER_HMAC_SECRET_TEMPLATES_OFF');"," }"," pm.response.to.have.status(403);","});"],"id":"85b0b4f4-6493-468d-9072-9e968b64e437"}}],"id":"f469f1d8-1d22-421a-8ae3-8c32772b5e36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"","type":"text"}],"url":"https://stagingapi.lawvo.com/inbound/document-templates?locale=en","description":"

Requires PARTNER_API_KEY_TEMPLATES_OFF and PARTNER_HMAC_SECRET_TEMPLATES_OFF for a group with Inbound API on but Document Templates toggle off.

Expected body: { \"error\": \"Document Templates API is not enabled for this group\" }

\n","urlObject":{"path":["inbound","document-templates"],"host":["https://stagingapi.lawvo.com"],"query":[{"key":"locale","value":"en"}],"variable":[]}},"response":[],"_postman_id":"f469f1d8-1d22-421a-8ae3-8c32772b5e36"}],"id":"ed959e1e-d416-48dc-8b60-176c624c13ed","description":"

Purpose

GET /inbound/document-templates returns paginated Basic Information metadata for templates your group may use.

Use case

Build a template picker in your app, or resolve environment-specific templateId values for Document Hub deep-links.

Required inputs

API Access + Document Templates enabled. Sign GET with canonical GET\\n/inbound/document-templates\\n<sorted query>. Optional query: locale (omit for all locales), categoryId, tagId, _start/_limit or page/pageSize.

Request example

List (default) for a basic catalog. List with filters + pagination for category + locale + page. Tag-only and locale-fr filters use the same query shape; they are not duplicated as separate examples.

Expected response

200 { data: [...], pagination: { start, limit, total } }. Fields include id, title, subtitle, categories, tags, locale, type, subCategories, duration, samplePdfUrl. No pricing or effectivePermission.

Common errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
401	Missing/wrong key or HMAC
403	IP block or Document Templates off
404	Unknown key / API Access off

Optional vars for the templates-off example: PARTNER_API_KEY_TEMPLATES_OFF, PARTNER_HMAC_SECRET_TEMPLATES_OFF.

Complete implementation flow

Enable Document Templates for the group.
Canonicalize query and sign.
GET list.
Use id values with landingContext create deep-links as needed.

\n","_postman_id":"ed959e1e-d416-48dc-8b60-176c624c13ed"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const reqName = (pm.info.requestName || '').toLowerCase();","if (reqName.includes('no auth')) return;","if (reqName.includes('invalid hmac')) return;","if (reqName.includes('open one-time')) return;","if (reqName.includes('open sso consume')) return;","const urlStr = pm.request.url.toString();","const isDocumentTemplatesGet ="," pm.request.method === 'GET' && urlStr.includes('/inbound/document-templates');","let hmacSecret = (pm.collectionVariables.get('PARTNER_HMAC_SECRET') || '').trim();","const apiKeyHeaderRaw = pm.request.headers.get('X-API-Key') || '';","const apiKeyHeader = pm.variables.replaceIn(apiKeyHeaderRaw).trim();","const ipBlockedKey = (pm.collectionVariables.get('PARTNER_API_KEY_IP_BLOCKED') || '').trim();","const templatesOffKey = (pm.collectionVariables.get('PARTNER_API_KEY_TEMPLATES_OFF') || '').trim();","if (apiKeyHeader && apiKeyHeader === ipBlockedKey) {"," hmacSecret = (pm.collectionVariables.get('PARTNER_HMAC_SECRET_IP_BLOCKED') || hmacSecret).trim();","} else if (apiKeyHeader && apiKeyHeader === templatesOffKey) {"," hmacSecret = (pm.collectionVariables.get('PARTNER_HMAC_SECRET_TEMPLATES_OFF') || hmacSecret).trim();","}","if (!hmacSecret) {"," throw new Error('Set collection variable PARTNER_HMAC_SECRET (or matching secret for IP/templates-off keys).');","}","let message = '';","if (isDocumentTemplatesGet) {"," const path = '/inbound/document-templates';"," const urlObj = pm.request.url;"," let rawQuery = '';"," if (urlObj && urlObj.query && urlObj.query.count()) {"," const parts = [];"," urlObj.query.each(function (item) {"," if (item.disabled) return;"," parts.push("," pm.variables.replaceIn(String(item.key || '')) +"," '=' +"," pm.variables.replaceIn(String(item.value ?? ''))"," );"," });"," rawQuery = parts.join('&');"," }"," const entries = rawQuery"," ? rawQuery.split('&').map(function (pair) {"," const idx = pair.indexOf('=');"," if (idx < 0) return [pair, ''];"," return [pair.slice(0, idx), pair.slice(idx + 1)];"," })"," : [];"," entries.sort(function (a, b) { return a[0].localeCompare(b[0]); });"," const query = entries"," .map(function (pair) {"," return encodeURIComponent(decodeURIComponent(pair[0])) + '=' + encodeURIComponent(decodeURIComponent(pair[1]));"," })"," .join('&');"," message = 'GET\\n' + path + '\\n' + query;","} else if (pm.request.method === 'POST') {"," const template ="," pm.request.body && pm.request.body.mode === 'raw' ? pm.request.body.raw || '' : '';"," const rawBody = pm.variables.replaceIn(template);"," if (pm.request.body && pm.request.body.mode === 'raw') {"," pm.request.body.raw = rawBody;"," }"," message = rawBody;","} else {"," return;","}","const sigHex = CryptoJS.HmacSHA256(message, hmacSecret).toString(CryptoJS.enc.Hex);","pm.request.headers.upsert({ key: 'X-Webhook-Signature', value: 'sha256=' + sigHex });"],"id":"912522b9-bcc3-4bd5-b67d-88d1b5a7f7c1"}}],"variable":[{"key":"baseUrl","value":"https://stagingapi.lawvo.com","description":"LawVo API host (no trailing slash). UAT or Live."},{"key":"PARTNER_API_KEY","value":"","description":"Inbound API key from LawVo (match environment to baseUrl)."},{"key":"PARTNER_HMAC_SECRET","value":"","description":"Inbound HMAC secret paired with your API key."},{"key":"lastLoginUrl","value":"","description":"Set after successful generate; used by Open one-time login URL."},{"key":"documentTemplatesCategoryId","value":"3","description":"Service category id for document template filter examples."},{"key":"documentTemplatesTagId","value":"98","description":"Tag id for document template filter examples."},{"key":"PARTNER_API_KEY_IP_BLOCKED","value":"","description":"Optional. API key for a group whose IP allowlist excludes your client (403 example)."},{"key":"PARTNER_HMAC_SECRET_IP_BLOCKED","value":"","description":"Optional. HMAC secret paired with PARTNER_API_KEY_IP_BLOCKED."},{"key":"PARTNER_API_KEY_TEMPLATES_OFF","value":"","description":"Optional. API key for a group with Document Templates toggle off (403 example)."},{"key":"PARTNER_HMAC_SECRET_TEMPLATES_OFF","value":"","description":"Optional. HMAC secret paired with PARTNER_API_KEY_TEMPLATES_OFF."}]}

LawVo inbound partner API

Setup

Supported origin slugs

Supported landingContext.serviceCategory slugs

HTTP responses (SSO)

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Purpose

Use case

Required inputs

Request example

Expected response

Common errors

Complete implementation flow

Supported `origin` slugs

Supported `landingContext.serviceCategory` slugs