Skip to main content
WEBHOOK
sosReport
{
  "companyName": "<string>",
  "formationDate": "2023-12-25",
  "reportFile": "<string>",
  "dataFile": "<string>",
  "watchlistHitsCount": -1
}

Headers

​
Idenfy-Event-Type
enum<string>
required
Available options:
SOS_REPORT
​
Idenfy-Signature
string

Webhook signature

Body

application/json
​
companyName
string | null
Maximum string length: 100
​
entityType
enum<string>
Available options:
CORPORATION,
LLC,
PARTNERSHIP,
NON_PROFIT,
TRUST,
SOLE_PROPRIETORSHIP
​
formationDate
string<date> | null
​
status
enum<string>
Available options:
NOT_ORDERED,
IN_PROGRESS,
FINISHED,
FAILED,
TIMED_OUT
​
reportFile
string<uri> | null
Pattern: (?:pdf)$
​
dataFile
string<uri> | null
Pattern: (?:json)$
​
watchlistHitsCount
integer | null
Required range: -2147483648 <= x <= 2147483647

Response

200

Return a 200 status to indicate that the data was received successfully.