Skip to content
Valjean SpecialtyValjean SpecialtyValjean Developer Docs

Overview

Check appetite, send submissions, answer what's needed, follow files, get quotes and ask to bind.

Valjean Specialty agent API 1.0.0

Section titled “Valjean Specialty agent API 1.0.0”

For retail agencies’ own software and AI assistants. Every key sees only its own agency’s files. A named Valjean broker works every file: chooses the markets, confirms anything you send, presents quotes and completes binding. Market names appear only on quotes your broker presents.

Operations

Section titled “Operations”
GET
/me
POST
/appetite
POST
/requirements
GET
/submissions
POST
/submissions
POST
/intake
GET
/submissions/{id}
POST
/submissions/{id}/answers
PATCH
/submissions/{id}/answers
GET
/submissions/{id}/flags
GET
/submissions/{id}/documents
POST
/submissions/{id}/documents
POST
/submissions/{id}/documents/upload-url
POST
/submissions/{id}/documents/complete
GET
/submissions/{id}/documents/{docId}
GET
/submissions/{id}/quotes
POST
/submissions/{id}/quotes/{quoteId}/bind-request
GET
/submissions/{id}/bind-requests
DELETE
/submissions/{id}/bind-requests/{bindRequestId}
POST
/submissions/{id}/instant-quotes
GET
/events
GET
/webhooks
POST
/webhooks
DELETE
/webhooks/{id}
POST
/webhooks/{id}/test
GET
/policies
GET
/policies/{id}
GET
/invoices
GET
/api/appetite
POST
/api/appetite
GET
/api/guides
GET
/api/guides/{key}
POST
A submission was created for your agency. WEBHOOK
POST
A submission moved to a new stage. WEBHOOK
POST
Valjean asked you for more information. WEBHOOK
POST
A market answered: anonymous counts, never names. WEBHOOK
POST
Your broker presented a quote. WEBHOOK
POST
A bind request moved forward. WEBHOOK
POST
A policy was bound. WEBHOOK
POST
A policy changed status (issued, cancelled, expired, renewed). WEBHOOK
POST
A binder, policy or endorsement is ready to download. WEBHOOK
POST
An invoice was sent to your agency. WEBHOOK
POST
An invoice was marked paid. WEBHOOK
POST
An invoice is past due. WEBHOOK
POST
Sent by POST /webhooks/{id}/test only. WEBHOOK

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Send the key as Authorization: Bearer vjk_…. Keys come from your agency portal or your Valjean broker.

Security scheme type: http

Bearer format: vjk_live_… / vjk_demo_… API key, or an OAuth access token (vjat_…)

apiKeyHeader

Section titled “apiKeyHeader”

The same API key in an X-Api-Key header, for tools that can’t set Authorization.

Security scheme type: apiKey

Header parameter name: X-Api-Key

oauth2

Section titled “oauth2”

For AI apps that connect by signing in. Authorization code flow with PKCE (S256 only), public clients (no secret), dynamic client registration at https://api.valjeanspecialty.com/oauth/register. Discovery: https://api.valjeanspecialty.com/.well-known/oauth-authorization-server. Access tokens last 1 hour; refresh tokens 30 days and rotate on use. Tokens stop when the API key or portal link that approved them is revoked.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://api.valjeanspecialty.com/oauth/authorize

Token URL: https://api.valjeanspecialty.com/oauth/token

Refresh URL: https://api.valjeanspecialty.com/oauth/token

Scopes:

  • read - Appetite, requirements, status, quotes, documents, policies
  • submit - Also send files, answers, documents, bind requests and instant-quote asks