Skip to content
Valjean SpecialtyValjean SpecialtyValjean Developer Docs

One class guide (no key)

GET
/api/guides/{key}
curl -X GET "https://api.valjeanspecialty.com/api/guides/gl_hospitality"

What Valjean needs for the class, with answer types, whether each item is confirmed with an underwriter, and a live appetite read for SC and GA.

No key needed.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
key
required
string

Guide key, e.g. gl_hospitality.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
key
required
string
name
required
string
class
required
string
line
required
string
line_name
required
string
naics_prefixes
required
Array<string>
keywords
required
Array<string>
updated_at
required
string format: date-time
appetite
required
Array<object>
object
state
required
string
fit
required
string
Allowed values: good possible unlikely unknown
headline
required
string
market_count_label
required
string
needs
required
Array<object>
object
key
required
string
label
required
string
level
required
string
Allowed values: required sometimes helpful
kind
required
string
answer
required
object
type
required

How to answer. “file” means upload a document instead.

string
Allowed values: text number money percent yes_no choice date file
options

For type “choice”: the allowed answers.

Array<string>
help
required
string | null
confirmed
required

False: Valjean’s typical list, not yet confirmed with an underwriter; say “typically”.

boolean
disclaimer
required
string

Example 

{
  "appetite": [
    {
      "fit": "good"
    }
  ],
  "needs": [
    {
      "level": "required",
      "answer": {
        "type": "text"
      }
    }
  ]
}

404

Section titled “404”

Not found, or not your agency’s (not_found). The API never says which.

Media typeapplication/json
object
error
required
object
code
required

Machine-readable code, e.g. invalid_request, read_only, not_found, closed, rate_limited.

string
message
required

Plain-English explanation you can show a person.

string
issues

Validation problems, as “field: problem” (400 invalid_request only).

Array<string>

Example 

{
  "error": {
    "code": "not_found",
    "message": "Submission not found."
  }
}

429

Section titled “429”

Too many requests (rate_limited): 120 a minute per key, 30 a minute per IP on public endpoints, counted across all of Valjean’s servers. Wait Retry-After seconds.

Media typeapplication/json
object
error
required
object
code
required

Machine-readable code, e.g. invalid_request, read_only, not_found, closed, rate_limited.

string
message
required

Plain-English explanation you can show a person.

string
issues

Validation problems, as “field: problem” (400 invalid_request only).

Array<string>

Example 

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Try again in a minute."
  }
}

Headers

Section titled “Headers”
Retry-After
integer
Example 
60

Seconds to wait.